Skip to content
Nairon Docs

/v1/instances/{instanceId}/upgrade

POST
/v1/instances/{instanceId}/upgrade
curl --request POST \
  --url https://service.v2.nairon.xyz/v1/instances/example/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "targetTemplateVersionId": "example", "newFieldValues": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
instanceId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
targetTemplateVersionId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
newFieldValues
object
key
additional properties
string
Examplegenerated
{
  "targetTemplateVersionId": "example",
  "newFieldValues": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
templateId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
templateVersionId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
organizationId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
projectId
required
Any of:
string format: cuid
/^[cC][0-9a-z]{6,}$/
name
required
string
fieldValues
required
status
required
string
Allowed values: provisioning active update_available updating failed archived
createdAt
required
string
updatedAt
required
string
Example
{
  "status": "provisioning"
}