Together AI API
Together AI DocsGet an API key
HomeAPI ReferenceSDKsContext Plugin
Remediation Service

List remediations

GET
/compute/clusters/{cluster_id}/instances/{instance_id}/remediations

Lists remediations for an instance or cluster.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

cluster_id*string
instance_id*string

To list remediations on a specific node, pass the node's instance ID. To list remediations for all nodes in a cluster, pass - as a wildcard for the instance ID.

Query Parameters

page_size?integer

Maximum results to return.

page_token?string

Pagination token from previous request.

state?array<>

Filter by state(s). Returns remediations matching any of the specified states.

  • PENDING_APPROVAL: Awaiting approval before processing can begin.
  • PENDING: Approved and queued for processing.
  • RUNNING: Actively being processed.
  • SUCCEEDED: Successfully completed.
  • FAILED: Failed with an error.
  • CANCELLED: Cancelled by user or system.
  • AUTO_RESOLVED: The underlying issue was automatically resolved before processing.
  • QUARANTINING: Cordoning or preparing the host before remediation.
  • QUARANTINED: Host has been cordoned or isolated for remediation.
order_by?string

Order by expression.

trigger?array<>

Filter by trigger type(s). Returns remediations matching any of the specified triggers.

mode?array<>

Filter by remediation mode(s). Returns remediations matching any of the specified modes.

Response Body

application/json

curl -X GET "https://example.com/compute/clusters/string/instances/string/remediations"
{  "remediations": [    {      "id": "string",      "cluster_id": "string",      "instance_id": "string",      "mode": "REMEDIATION_MODE_VM_ONLY",      "trigger": "REMEDIATION_TRIGGER_MANUAL",      "state": "PENDING_APPROVAL",      "reason": "string",      "active_health_check_run_id": "string",      "passive_health_check_event_id": "string",      "requested_by": "string",      "create_time": "2019-08-24T14:15:22Z",      "reviewed_by": "string",      "review_time": "2019-08-24T14:15:22Z",      "review_comment": "string",      "start_time": "2019-08-24T14:15:22Z",      "end_time": "2019-08-24T14:15:22Z",      "error_message": "string",      "update_time": "2019-08-24T14:15:22Z",      "instance_name": "string",      "linked_alerts": [        {          "passive_health_check_alert_id": "string",          "instance_id": "string",          "cluster_id": "string",          "target_vm": "string",          "alert_name": "string",          "severity": "PHC_SEVERITY_INFO",          "annotations": {            "property1": "string",            "property2": "string"          },          "started_at": "2019-08-24T14:15:22Z",          "resolved_at": "2019-08-24T14:15:22Z",          "node_remediation_intent_id": "string",          "annotation": {            "title": "string",            "description": "string",            "summary_line": "string",            "xid": {              "events": [                {                  "xid_code": "string",                  "mnemonic": "string",                  "count": 0                }              ]            },            "slurm_node_unavailable": {              "reason": "string"            }          }        }      ]    }  ],  "next_page_token": "string",  "has_next": true}

Instance Cluster Add On Service Update PUT

Previous Page

Remediation Service Create Remediation POST

Creates a new remediation for an instance. Remediations created via the API goes directly to PENDING state. Our system may trigger automated remediations that require approval. These remediations are created with PENDING_APPROVAL state. The user must call /approve to start the actual remediation process. These operations can also be rejected by calling /reject.