Skip to content

Update a service

PUT
/v1/service/{id}/

Replace all mutable fields of an existing service.

id
required
string format: uuid

A UUID string identifying this service.

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
account_config
required
string format: uuid
active
boolean
agent
string format: uuid
nullable
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
nullable
deactivated_at
string format: date-time
nullable
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
<= 250 characters
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
""
label
required
string
<= 1000 characters
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
nullable
monitor_ca_file
string
monitor_expected_content
string
monitor_expected_response_code
integer
nullable >= -2147483648 <= 2147483647
monitor_headers
monitor_unexpected_content
string
monitor_url
string
nullable <= 1000 characters
status_descriptions
required
Array<string>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
account_config
required
string format: uuid
active
boolean
agent
string format: uuid
nullable
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
nullable
deactivated_at
string format: date-time
nullable
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
<= 250 characters
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
""
label
required
string
<= 1000 characters
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
nullable
monitor_ca_file
string
monitor_expected_content
string
monitor_expected_response_code
integer
nullable >= -2147483648 <= 2147483647
monitor_headers
monitor_unexpected_content
string
monitor_url
string
nullable <= 1000 characters
status_descriptions
required
Array<string>