Palo Alto Networks Certificates API
The Certificates API from Palo Alto Networks — 15 operation(s) for certificates.
The Certificates API from Palo Alto Networks — 15 operation(s) for certificates.
openapi: 3.2.0
info:
title: Palo Alto Networks Certificates API
version: '1.0'
description: 'Operations tagged Certificates across 3 of this provider''s published API definitions: palo-alto-access-prisma-access-config-certificates-openapi.yaml, palo-alto-scm-config-cloudngfw-identity-identity-services-openapi.yaml, palo-alto-scm-config-ngts-tlsprotect-cloud-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sase.paloaltonetworks.com
- url: https://api.strata.paloaltonetworks.com/config/identity/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
tags:
- name: Certificates
paths:
/sse/config/v1/certificates:
get:
description: 'List certificates.
'
operationId: get-sse-config-v1-certificates
parameters:
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
- $ref: '#/components/parameters/name-optional'
- $ref: '#/components/parameters/folder'
responses:
'200':
content:
application/json:
schema:
properties:
data:
allOf:
- items:
$ref: '#/components/schemas/certificates-get'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of certificates info
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: List certificates
tags:
- Certificates
post:
description: 'Create a certificate.
'
operationId: post-sse-config-v1-certificates
parameters:
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-post'
description: The certificate info you want to create
responses:
'201':
$ref: '#/components/responses/http_created'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Create certificates
tags:
- Certificates
servers:
- url: https://api.sase.paloaltonetworks.com
/sse/config/v1/certificates/{id}:
delete:
description: 'Delete a certificate.
'
operationId: delete-sse-config-v1-certificates-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
$ref: '#/components/responses/http_ok'
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Delete certificates
tags:
- Certificates
servers:
- url: https://api.sase.paloaltonetworks.com
/sse/config/v1/certificates:import:
post:
description: 'Import a certificate.
'
operationId: post-sse-config-v1-certificates:import
parameters:
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-import'
description: The certificate you want to import
responses:
'201':
$ref: '#/components/responses/http_created'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Import a certificate
tags:
- Certificates
servers:
- url: https://api.sase.paloaltonetworks.com
/certificates:
get:
tags:
- Certificates
summary: List certificates
description: 'Retrieve a list of certificates.
'
operationId: ListCertificates
parameters:
- $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/folder_2'
- $ref: '#/components/parameters/snippet'
- $ref: '#/components/parameters/device'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
allOf:
- type: array
items:
$ref: '#/components/schemas/certificates-get_2'
limit:
type: integer
default: 200
offset:
type: integer
default: 0
total:
type: integer
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
post:
tags:
- Certificates
summary: Generate a certificate
description: 'Generate a new certificate.
'
operationId: CreateCertificates
requestBody:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-post_2'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-get_2'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/identity/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
/certificates:import:
post:
tags:
- Certificates
summary: Import a certificate
description: 'Import a certificate.
'
operationId: ImportCertificates
requestBody:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-import_2'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-import_2'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/identity/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
/certificates/{id}:
get:
tags:
- Certificates
summary: Get a certificate
description: 'Get an existing certificate.
'
operationId: GetCertificatesByID
parameters:
- $ref: '#/components/parameters/uuid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/certificates-get_2'
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
delete:
tags:
- Certificates
summary: Delete a certificate
description: 'Delete a certificate.
'
operationId: DeleteCertificatesByID
parameters:
- $ref: '#/components/parameters/uuid'
responses:
'200':
$ref: '#/components/responses/http_ok_2'
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/identity/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
/certificates/{id}:export:
post:
tags:
- Certificates
summary: Export a certificate
description: 'Export a certificate.
'
operationId: ExportCertificateByID
parameters:
- $ref: '#/components/parameters/uuid'
requestBody:
description: Export a Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/export-certificate-payload'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/export-certificate-response'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/config/identity/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
/outagedetection/v1/certificates:
get:
description: 'This endpoint allows you to retrieve all your certificates according to a specified criteria. This API provides a quick way to gather certificate details in order to install the certificates where they are needed.
Use the `subject` query parameter to limit the search based on the certificate subject common name.'
operationId: certificates_getAll
parameters:
- in: query
name: ownershipTree
schema:
default: false
type: boolean
- in: query
name: excludeSupersededInstances
schema:
default: false
type: boolean
- description: Ability to enter regular expression to match specific criteria.
in: query
name: subject
schema:
type: string
- description: Indicates the maximum integer number of certificates returned.
in: query
name: limit
schema:
default: 1000
maximum: 10000
minimum: 1
type: number
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateResponse'
text/csv:
schema:
$ref: '#/components/schemas/CertificateResponse'
description: Certificate(s) response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/csv:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/csv:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
summary: Retrieve all certificate data
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/{id}:
get:
description: Retrieves the details of the certificate that has the specified `id`.
operationId: certificates_getById
parameters:
- description: Indicates whether response should include nested ownership data (e.g., `owningContainers`).
in: query
name: ownershipTree
schema:
default: false
type: boolean
- in: query
name: excludeSupersededInstances
schema:
default: false
type: boolean
- description: UUID of a Certificate.
in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedCertificateInformation'
description: Certificate was found; details in response body.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Certificate was not found.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
summary: Get a certificate details
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/{id}/contents:
get:
description: Exports the certificate that has the specified `id` in PEM or DER format. Chain CA certificates are included for PEM format when `chainOrder` is EE_FIRST or ROOT_FIRST.
operationId: certificates_getContentsById
parameters:
- description: Specify an 'accept' header parameter's value
in: header
name: Accept
schema:
enum:
- text/plain
- application/octet-stream
type: string
- description: UUID of a Certificate.
in: path
name: id
required: true
schema:
format: uuid
type: string
- description: Format of certificate in response.
in: query
name: format
schema:
enum:
- PEM
- DER
type: string
- description: Order of certificates in response.
in: query
name: chainOrder
schema:
enum:
- EE_ONLY
- EE_FIRST
- ROOT_FIRST
type: string
responses:
'200':
content:
application/json:
schema:
type: string
application/octet-stream:
schema:
type: string
text/plain:
schema:
type: string
description: Raw certificate in response body
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/plain:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/plain:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Certificate not found.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/plain:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
summary: Download a certificate
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/validation:
post:
description: Submits one or more certificates for TLS validation.
operationId: certificates_validation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateValidationRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateValidationResponse'
description: Certificates submitted for validation response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
summary: Request validation for a set of
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/retirement:
post:
description: This endpoint retires one or more certificates by using the **certificateIds** parameter to match a specified value.
operationId: certificateretirement_retireCertificates
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateRetirementRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateResponse'
description: Certificate retirement response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
summary: Retire certificates
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/recovery:
post:
description: Recover the certificates specified by `certificateIds`, including any previous versions of those certificates.
operationId: certificateretirement_recoverCertificates
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateRecoveryRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateResponse'
description: Certificates were recovered. Total number and details are in the response body.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
summary: Recover a set of certificates
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificates/deletion:
post:
description: Permanently deletes the retired certificates specified by `certificateIds` from the inventory.
operationId: certificateretirement_deleteCertificates
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateDeletionRequest'
required: true
responses:
'204':
description: Certificates were deleted.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Incomplete or malformed request.
summary: Delete a set of retired certificates
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
/outagedetection/v1/certificatesearch:
post:
description: 'This endpoint retrieves certificate data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/).
'
operationId: certificates_search_getByExpression
parameters:
- in: query
name: ownershipTree
schema:
default: false
type: boolean
- in: query
name: excludeSupersededInstances
schema:
default: false
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Filter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateResponse'
text/csv:
schema:
$ref: '#/components/schemas/CertificateResponse'
description: Certificate response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/csv:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
'412':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse4'
text/csv:
schema:
$ref: '#/components/schemas/ErrorResponse4'
description: Request conditions failed.
summary: Retrieve certificate data matching search criteria
tags:
- Certificates
security:
- scmToken: []
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
components:
examples:
json_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
details: {}
message: Key Expired
_request_id: abcd-1234
json_501_panui_restapi_method_not_supported:
summary: Method Not Supported
value:
_errors:
- code: E012
details: {}
message: Method Not Supported
_request_id: abcd-1234
json_400_panui_restapi_input_format_mismatch:
summary: Input Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Input Format Mismatch: input-format=json'
_request_id: abcd-1234
json_501_panui_restapi_version_not_supported:
summary: Version Not Supported
value:
_errors:
- code: E012
details: {}
message: Version Not Supported
_request_id: abcd-1234
json_409_panui_mgmt_name_not_unique:
summary: Name Not Unique
value:
_errors:
- code: E006
details: {}
message: Name Not Unique
_request_id: abcd-1234
json_409_panui_mgmt_object_not_unique:
summary: Object Not Unique
value:
_errors:
- code: E016
details: {}
message: Object Not Unique
_request_id: abcd-1234
json_404_panui_mgmt_object_not_present:
summary: Object Not Present
value:
_errors:
- code: E005
details: {}
message: Object Not Present
_request_id: abcd-1234
json_400_panui_restapi_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
details: {}
message: Missing Body
_request_id: abcd-1234
json_409_panui_mgmt_reference_not_zero:
summary: Reference Not Zero
value:
_errors:
- code: E009
details: {}
message: Reference Not Zero
_request_id: abcd-1234
json_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
details: {}
message: Invalid Command
_request_id: abcd-1234
json_400_panui_restapi_output_format_mismatch:
summary: Output Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Output Format Mismatch: output-format=json Accept=xml'
_request_id: abcd-1234
json_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
details: {}
message: Not Authenticated
_request_id: abcd-1234
json_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
details: {}
message: Invalid Credential
_request_id: abcd-1234
json_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
details: {}
message: Unauthorized
_request_id: abcd-1234
json_400_panui_restapi_missing_query_parameter:
summary: Missing Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Missing Query Parameter: name'
_request_id: abcd-1234
json_405_panui_restapi_action_not_supported:
summary: Action Not Supported
value:
_errors:
- code: E012
details: {}
message: 'Action Not Supported: move'
_request_id: abcd-1234
json_400_panui_restapi_invalid_query_parameter:
summary: Invalid Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Invalid Query Parameter: location=invalid'
_request_id: abcd-1234
json_401_panui_auth_key_too_long:
summary: Key Too Long
value:
_errors:
- code: E016
details: {}
message: Key Too Long
_request_id: abcd-1234
json_400_panui_mgmt_invalid_object:
summary: Invalid Object
value:
_errors:
- code: E003
details: {}
message: Invalid Object
_request_id: abcd-1234
json_400_panui_mgmt_malformed_command:
summary: Malformed Command
value:
_errors:
- code: E003
details: {}
message: Malformed Command
_request_id: abcd-1234
json_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: 4
details: {}
message: Session Timeout
_request_id: abcd-1234
json_401_panui_auth_need_password_change:
summary: Need Password Change
value:
_errors:
- code: E016
details: {}
message: The password needs to be changed.
_request_id: abcd-1234
json_400_panui_mgmt_bad_xpath:
summary: Bad XPath
value:
_errors:
- code: E013
details: {}
message: Bad XPath
_request_id: abcd-1234
json_401_panui_auth_key_expired_2:
summary: Key Expired
value:
_errors:
- code: E016
message: Key Expired
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_method_not_supported_2:
summary: Method Not Supported
value:
_errors:
- code: E012
message: Method Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_input_format_mismatch_2:
summary: Input Format Mismatch
value:
_errors:
- code: E003
message: 'Input Format Mismatch: input-format=json'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_version_not_supported_2:
summary: Version Not Supported
value:
_errors:
- code: E012
message: Version Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_name_not_unique_2:
summary: Name Not Unique
value:
_errors:
- code: E006
message: Name Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_object_not_unique_2:
summary: Object Not Unique
value:
_errors:
- code: E016
message: Object Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_404_panui_mgmt
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-certificates-api-openapi.yml