Skip to content
Doprax DocsDoprax DocsDoprax Docs

v2_services_instances_detail_update

PUT
/api/v2/services/instances/{service_id}/detail/
curl --request PUT \
  --url https://example.com/api/v2/services/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/detail/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "description": "example" }'

Update the VM’s name and/or description. At least one field is required.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
service_id
required
string format: uuid

Request Body

Section titled “Request Body”
object
name
string
description
string

Example generated

{
  "name": "example",
  "description": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
success
required
boolean
data
nullable
meta
object
page
integer
size
integer
total
integer
active_total
integer
total_pages
integer
has_next
boolean
has_prev
boolean
sort_by
string
sort_dir
string
msg
object
msg_kind
string
msg_text
string
error
string
pagination
object
count
integer
next
string
nullable
previous
string
nullable

Example generated

{
  "success": true,
  "data": "example",
  "meta": {
    "page": 1,
    "size": 1,
    "total": 1,
    "active_total": 1,
    "total_pages": 1,
    "has_next": true,
    "has_prev": true,
    "sort_by": "example",
    "sort_dir": "example"
  },
  "msg": {
    "msg_kind": "example",
    "msg_text": "example"
  },
  "error": "example",
  "pagination": {
    "count": 1,
    "next": "example",
    "previous": "example"
  }
}

400

Section titled “400”
Media typeapplication/json
object
success
boolean
error
string

Example 

{
  "success": false
}

404

Section titled “404”
Media typeapplication/json
object
success
required
boolean
data
nullable
meta
object
page
integer
size
integer
total
integer
active_total
integer
total_pages
integer
has_next
boolean
has_prev
boolean
sort_by
string
sort_dir
string
msg
object
msg_kind
string
msg_text
string
error
string
pagination
object
count
integer
next
string
nullable
previous
string
nullable

Example generated

{
  "success": true,
  "data": "example",
  "meta": {
    "page": 1,
    "size": 1,
    "total": 1,
    "active_total": 1,
    "total_pages": 1,
    "has_next": true,
    "has_prev": true,
    "sort_by": "example",
    "sort_dir": "example"
  },
  "msg": {
    "msg_kind": "example",
    "msg_text": "example"
  },
  "error": "example",
  "pagination": {
    "count": 1,
    "next": "example",
    "previous": "example"
  }
}