Update a service
PUT
/v1/service/{id}/
const url = 'https://example.com/v1/service/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"active":true,"agent":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","deactivated_at":"2026-04-15T12:00:00Z","display_name":"example","exe_path":"example","instance":"example","label":"example","listen_addresses":"example","monitor":true,"monitor_ca_file":"example","monitor_expected_content":"example","monitor_expected_response_code":1,"monitor_headers":"example","monitor_unexpected_content":"example","monitor_url":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/v1/service/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "agent": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "deactivated_at": "2026-04-15T12:00:00Z", "display_name": "example", "exe_path": "example", "instance": "example", "label": "example", "listen_addresses": "example", "monitor": true, "monitor_ca_file": "example", "monitor_expected_content": "example", "monitor_expected_response_code": 1, "monitor_headers": "example", "monitor_unexpected_content": "example", "monitor_url": "example" }'Replace all mutable fields of an existing service.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
A UUID string identifying this service.
Request Bodyrequired
Section titled “Request Bodyrequired”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
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
deactivated_at
string format: date-time
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
label
required
string
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
monitor_ca_file
string
monitor_expected_content
string
monitor_expected_response_code
integer
monitor_headers
monitor_unexpected_content
string
monitor_url
string
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
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
deactivated_at
string format: date-time
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
label
required
string
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
monitor_ca_file
string
monitor_expected_content
string
monitor_expected_response_code
integer
monitor_headers
monitor_unexpected_content
string
monitor_url
string
status_descriptions
required
Array<string>
Responses
Section titled “Responses”Media typeapplication/json
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
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
deactivated_at
string format: date-time
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
label
required
string
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
monitor_ca_file
string
monitor_expected_content
string
monitor_expected_response_code
integer
monitor_headers
monitor_unexpected_content
string
monitor_url
string
status_descriptions
required
Array<string>
Example
{ "kubernetes_cluster_name": ""}