Get an agent service instance
import requests
url = "https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id} \
--header 'Authorization: Bearer <token>'{
"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": "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>"
}Agent Deployments
Get an agent service instance
GET
/
v1
/
agent-deployments
/
{deployment_id}
/
services
/
{service_id}
Get an agent service instance
import requests
url = "https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.13-215-85-171.sslip.io/v1/agent-deployments/{deployment_id}/services/{service_id} \
--header 'Authorization: Bearer <token>'{
"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": "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>"
}Authorizations
API key passed as Bearer token
Path Parameters
Agent deployment ID
Agent service instance ID
Response
Agent service instance
Example:
"adsvc_1234abcd"
Available options:
starting, ready, unhealthy, stopping, stopped, failed Required range:
1 <= x <= 65535Dynamic 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.
Server-recorded readiness/lifecycle status detail for the service instance. Key set varies by lifecycle phase; deliberately open.