Get deployment

cURL

curl --request GET \
  --url https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "type": "production",
  "status": "active",
  "is_default": 0,
  "connection_status": "healthy",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_resynced_at": "2023-11-07T05:31:56Z",
  "tags": {},
  "object": "deployment",
  "auth_settings": {
    "gateway_base_url": "<string>",
    "mcp_gateway_base_url": "<string>",
    "private_link_endpoint": "<string>",
    "use_private_link_proxy": 0,
    "is_dataservice_hosted": 0,
    "is_playground_proxy_allowed": 0,
    "disable_portkey_gateway": 0,
    "workspaces_allowed": [
      "<string>"
    ],
    "jwt_subs_allowed": [
      "<string>"
    ],
    "jwt_sub_workspace_mapping": {},
    "allow_all_workspaces": 0
  },
  "deployment_config": {},
  "workspaces": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>"
    }
  ],
  "credentials": {
    "username": "<string>",
    "password": "<string>"
  },
  "client_auth": "<string>"
}

GET

deployments

{deploymentId}

cURL

curl --request GET \
  --url https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.apps.paloaltonetworks.com/ai_gw/admin/v2/deployments/{deploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "type": "production",
  "status": "active",
  "is_default": 0,
  "connection_status": "healthy",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_resynced_at": "2023-11-07T05:31:56Z",
  "tags": {},
  "object": "deployment",
  "auth_settings": {
    "gateway_base_url": "<string>",
    "mcp_gateway_base_url": "<string>",
    "private_link_endpoint": "<string>",
    "use_private_link_proxy": 0,
    "is_dataservice_hosted": 0,
    "is_playground_proxy_allowed": 0,
    "disable_portkey_gateway": 0,
    "workspaces_allowed": [
      "<string>"
    ],
    "jwt_subs_allowed": [
      "<string>"
    ],
    "jwt_sub_workspace_mapping": {},
    "allow_all_workspaces": 0
  },
  "deployment_config": {},
  "workspaces": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>"
    }
  ],
  "credentials": {
    "username": "<string>",
    "password": "<string>"
  },
  "client_auth": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

deploymentId

string

required

Response

string<uuid>

name

string

slug

string

type

enum<string>

Available options:

production,

non_production

status

enum<string>

Available options:

active,

archived

is_default

enum<integer>

Available options:

0,

1

connection_status

enum<string>

Available options:

healthy,

unhealthy,

unknown

created_by

string

created_at

string<date-time>

last_updated_at

string<date-time>

last_synced_at

string<date-time> | null

last_resynced_at

string<date-time> | null

API Reference

Gateway Configuration

Providers and Credentials

MCP

Administration

Observability

Authorizations

Path Parameters

Response