Restore Distributions

Restore a previously deleted agent installation package by its distribution ID.

Restore a deleted agent installation package

post

Restores a previously deleted agent installation package (distribution), re-enabling agent registration for agents that reference it.

A distribution can be deleted via the Delete agent installation packages API or from the Agent Installations screen in Cortex Cloud. Restoring the distribution re-enables agent registration.

If the distribution is already in an active (non-deleted) state, the API returns a message indicating it is already restored rather than returning an error.

Required license: Cortex Cloud Runtime Security. In Cortex Cloud Posture Security, you need the Cortex Cloud Runtime Security add-on.

Authorizations

AuthorizationstringRequired

API key for authenticating requests. Pass the API key in the Authorization header.

x-xdr-auth-idstringRequired

API key ID for authenticating requests. Pass the API key ID in the x-xdr-auth-id header.

Header parameters

AuthorizationstringRequired

API key for authentication.

x-xdr-auth-idstringRequired

API key ID for authentication.

Body

Request body for restoring a deleted distribution.

Responses

200

The restore operation was processed. The reply field contains a message indicating whether the distribution was successfully restored or was already in an active state.

application/json

Response returned after a restore operation is processed.

replystringOptional

A human-readable message describing the outcome of the restore operation. Returns "Successfully restored distribution <id>" when the distribution was restored, or "Distribution <id> is already restored" when the distribution was already in an active state.

Example: Successfully restored distribution e1c8a20d9d2c4ae6b4e7e6b7437847bc

400

Bad request. The distribution_id is missing or malformed.

application/json

401

Unauthorized. The API key or key ID is missing or invalid.

application/json

403

Forbidden. The API key does not have permission to restore distributions.

application/json

404

Not found. No distribution exists with the specified distribution_id.

application/json

500

Internal server error. An unexpected error occurred while processing the restore request.

application/json

post/public_api/v1/distributions/restore

POST /public_api/v1/distributions/restore HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "request_data": {
    "distribution_id": "e1c8a20d9d2c4ae6b4e7e6b7437847bc"
  }
}

{
  "reply": "Successfully restored distribution e1c8a20d9d2c4ae6b4e7e6b7437847bc"
}