Create Distributions
Create an installation package.
Synopsis
URI | /public_api/v1/distributions/get_versions/ |
HTTP Method | POST |
Required License | Cortex XDR Prevent or Cortex XDR Pro per Endpoint |
Description
Create an installation package.
This is an async call that returns the distribution ID, it does
not mean that the creation succeeded. To confirm the package has been
created, check the status of the distribution by running the
Get
Distribution Status
API.Request Fields
The body of this request
contains a JSON object with the following fields:
Field | Description |
---|---|
request_data | ( Required ) A dictionary containing
the API request fields. |
name | ( Required ) A string representing
the name of the installation package. |
package_type | ( Required ) A string representing
the type of package to create. Each JSON object must contain one of
the following keywords:
|
description | String representing information about the package. |
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/distributions/get_versions/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "request_data":{ "name":"<installation package name>", "platform":"windows", "package_type":"standalone", "agent_version":"<agent version>" } }'
Success Response
Upon success,
the HTTP response code is 200. In addition, this API returns a JSON
object containing the query status, as well as an array of JSON
objects, each of which represents a single distribution ID.
Field | Description |
---|---|
reply | JSON object containing the query result. |
distribution_id | The installation package ID. |
Success Response Example
{ "reply":{ "distribution_id":"<distribution ID value>" } }
Error Response
Upon error,
the reply includes an HTTP response code, an error message, and
additional information describing the error. The HTTP response code
is one of the following:
Field | Description |
---|---|
400 | Bad Request. Got an invalid JSON. |
401 | Unauthorized access. An issue occurred during authentication.
This can indicate an incorrect key, id, or other invalid authentication
parameters. |
402 | Unauthorized access. User does not have the
required license type to run this API. |
403 | Forbidden access. The provided API Key does
not have the required RBAC permissions to run this API. |
500 | Internal server error. A unified status for
API communication type errors. |
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}
Recommended For You
Recommended Videos
Recommended videos not found.