Skip to main content
PUT
/
iam
/
clients
/
{clientId}
/
services
/
{serviceId}
Update service's details
curl --request PUT \
  --url https://api.gcore.com/iam/clients/{clientId}/services/{serviceId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "options": [
    {
      "id": 123,
      "value": "<string>",
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "title": "<string>"
    }
  ],
  "status_transition_options": [
    {
      "id": 123,
      "value": "<string>",
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "title": "<string>"
    }
  ]
}
'
{
  "id": 123,
  "client": 123,
  "status": "paused",
  "previous_status": "active",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "start": "2023-11-07T05:31:56Z",
  "enabled": true,
  "options": [
    {
      "id": 123,
      "value": "<string>",
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "title": "<string>"
    }
  ],
  "status_transition_options": [
    {
      "id": 123,
      "value": "<string>",
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "title": "<string>"
    }
  ],
  "deleted_date": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
clientId
integer
required

Account ID.

​
serviceId
integer
required

Service's ID.

Body

application/json
​
status
enum<string>
required

Status of the service.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
enabled
boolean

Shows if a service is enabled or disabled.

​
options
object[]

List of service options to update.

​
status_transition_options
object[]

List of status transition options.

Response

OK.

​
id
integer
required
read-only

Service's ID.

​
name
enum<string>
required

Service's name.

Available options:
CDN,
STORAGE,
STREAMING,
DNS,
DDOS,
CLOUD
​
client
integer
required
read-only

Client's ID.

​
status
enum<string>
required

Status of the service.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
Example:

"paused"

​
previous_status
enum<string>
required

Status of the service.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
Example:

"active"

​
status_changed_at
string<date-time>
required
read-only

When status was changed.

​
start
string<date-time>
required
read-only

Trial start date.

​
enabled
boolean
required

Shows if a service is enabled or disabled.

​
options
object[]
required

List of service options.

​
status_transition_options
object[]
required

List of status transition options.

​
deleted_date
string<date-time> | null
read-only

Date and time when service's status will be changed to deleted.

Applicable only if current service's status is trialend or paused.