Restart an agent service instance

import requests

url = "https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}/restart"

payload = {
    "reason": "<string>",
    "envs": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}/restart \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "envs": {}
}
'

{
  "id": "adsvc_1234abcd",
  "deployment_id": "<string>",
  "version_id": "<string>",
  "status": "starting",
  "port": 32768,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_id": "<string>",
  "process_id": 123,
  "public_url": "<string>",
  "readiness_status": {},
  "failure_reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "stopped_at": "2023-11-07T05:31:56Z",
  "idempotency_key": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "Missing or invalid bearer credential",
  "code": "unauthorized",
  "request_id": "req_123"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

POST

agent-deployments

{deployment_id}

services

{service_id}

restart

Restart an agent service instance

import requests

url = "https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}/restart"

payload = {
    "reason": "<string>",
    "envs": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}/restart \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "envs": {}
}
'

{
  "id": "adsvc_1234abcd",
  "deployment_id": "<string>",
  "version_id": "<string>",
  "status": "starting",
  "port": 32768,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "machine_id": "<string>",
  "process_id": 123,
  "public_url": "<string>",
  "readiness_status": {},
  "failure_reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "stopped_at": "2023-11-07T05:31:56Z",
  "idempotency_key": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "Missing or invalid bearer credential",
  "code": "unauthorized",
  "request_id": "req_123"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

{
  "error": "<string>",
  "code": "invalid_request",
  "error_detail": {
    "code": "unauthorized",
    "message": "<string>",
    "phase": "auth",
    "retryable": true,
    "suggested_action": "<string>",
    "step_index": 123,
    "attempt": 123,
    "max_attempts": 123,
    "cache_subject": "<string>",
    "build_id": "<string>",
    "request_id": "<string>",
    "details": {}
  },
  "request_id": "<string>",
  "build_id": "<string>"
}

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Path Parameters

deployment_id

string

required

Agent deployment ID

service_id

string

required

Agent service instance ID

Body

application/json

reason

string | null

envs

object

write-only

Request-only runtime environment variable values. P0 accepts string values only; future secret references are reserved by AgentSecretReference. Values are injected into agent processes and are not stored in deployment config, run, service, or platform event records.

Show child attributes

Response

Service restart recorded

string

required

Example:

"adsvc_1234abcd"

deployment_id

string

required

version_id

string

required

status

enum<string>

required

Available options:

starting,

ready,

unhealthy,

stopping,

stopped,

failed

port

integer

required

Required range: 1 <= x <= 65535

created_at

string<date-time>

required

updated_at

string<date-time>

required

machine_id

string | null

process_id

integer<uint32> | null

public_url

string<uri> | null

Dynamic public URL for the ready service. Signed edge URLs contain bearer credentials such as edge_token; do not log or persist them. A null value means the service is not ready, has no backing machine, or permissions.public_url is disabled.

readiness_status

object | null

Server-recorded readiness/lifecycle status detail for the service instance. Key set varies by lifecycle phase; deliberately open.

failure_reason

string | null

started_at

string<date-time> | null

stopped_at

string<date-time> | null

idempotency_key

string | null

Overview

Endpoints

Restart an agent service instance

Authorizations

Path Parameters

Body

Response