Outpost Management

Use these APIs to create or edit templates for onboarding outposts.

Create an outpost template

post

Create a template to onboard an outpost. Define the custom resource tags you want associated with the outpost and Cortex generates an authentication template to establish trust to the CSP and grant permissions to Cortex.

Required license: Cortex Cloud Posture Management

Header parameters

AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

Responses

200

Successful Response

application/json

replyobjectOptional

The main payload of the response, containing a link to download the outpost template

422

Invalid Client Request Error

application/json

500

Internal Server Error

application/json

post/public_api/v1/cloud_onboarding/create_outpost_template

POST /public_api/v1/cloud_onboarding/create_outpost_template HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "request_data": {
    "cloud_provider": "AWS",
    "custom_resources_tags": [
      {
        "key": "managed_by",
        "value": "paloaltonetworks"
      }
    ]
  }
}

{
  "reply": {
    "automated": {},
    "manual": {
      "TF": "https://qa2-test-9999219916297-cloud-onboarding-templates.storage.googleapis.com/outposts/aws/tf-12711a531d51412d930a647ed2fdacdf-1743447640.tar.gz?Expires=1744052440&GoogleAccessId=api-pod%40qa2-test-9999219916297.iam.gserviceaccount.com&Signature=&response-content-disposition=attachment%3Bfilename%3Doutposts_aws_tf-12711a531d51412d930a647ed2fdacdf-1743447640.tar.gz"
    }
  }
}

Edit an outpost

post

Edit the custom resource tags of the specified outpost. The template must be applied in the CSP after editing.

Required license: Cortex Cloud Posture Management

Header parameters

AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

Responses

200

Successful Response

application/json

422

Invalid Client Request Error

application/json

500

Internal Server Error

application/json

post/public_api/v1/cloud_onboarding/edit_outpost

POST /public_api/v1/cloud_onboarding/edit_outpost HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "request_data": {
    "id": "text",
    "custom_resources_tags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
}

{
  "reply": {
    "automated": {
      "link": "text",
      "tracking_guid": "text"
    },
    "manual": {
      "TF/ARM": "text"
    }
  }
}

Get all or filtered outposts

post

Get a list of all or filtered outposts.

Required license: Cortex Cloud Posture Management

Header parameters

AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

Responses

200

OK

application/json

post/public_api/v1/cloud_onboarding/get_outposts

POST /public_api/v1/cloud_onboarding/get_outposts HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "request_data": {
    "filter_data": {
      "sort": [
        {
          "FIELD": "CREATED_AT",
          "ORDER": "ASC"
        }
      ],
      "filter": {
        "OR": [
          {
            "SEARCH_FIELD": "CLOUD_PROVIDER",
            "SEARCH_TYPE": "CONTAINS",
            "SEARCH_VALUE": "AWS"
          },
          {
            "SEARCH_FIELD": "CLOUD_PROVIDER",
            "SEARCH_TYPE": "CONTAINS",
            "SEARCH_VALUE": "GCP"
          }
        ]
      },
      "paging": {
        "from": 0,
        "to": 20
      }
    }
  }
}

200

OK

{
  "reply": {
    "DATA": [
      {
        "cloud_provider": "AWS",
        "outpost_id": "094935393dcf46128e5a2138a51bd54a",
        "created_at": "1748309918599",
        "type": "MANAGED"
      }
    ],
    "FILTER_COUNT": 1,
    "TOTAL_COUNT": 1
  }
}