Splunk Observability Cloud Synthetics CA certificates
API for creating, updating, and deleting Certificate Authority (CA) certificates.
OpenAPI Specification
openapi: 3.0.3
info:
title: Splunk Observability Cloud — Synthetics CA certificates
version: 1.0.0
description: 'API for creating, updating, and deleting Certificate Authority (CA) certificates.
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin, power, or read_only role to use this API.'
x-provenance:
method: reconstructed
authored_by: Splunk (content) / API Evangelist (assembly)
reconstructed_by: API Evangelist
reconstructed_on: '2026-08-19'
first_party: false
provider_published: false
note: Splunk's own OpenAPI objects, extracted from the React Server Component payload embedded in each of the 48 API reference
pages at dev.splunk.com. The operations and schemas are Splunk's; the assembly into standalone documents is API Evangelist's.
Splunk serves no fetchable spec file — dev.splunk.com answers 200 with an identical 6,638-byte shell for every asset
path, including invented control paths — so this is NOT first-party publication and is not graded as such.
x-evidence:
- type: source
url: https://dev.splunk.com/observability/reference/
- type: source
url: https://dev.splunk.com/observability/docs/apibasics/api_list/
servers:
- url: https://api.{REALM}.observability.splunkcloud.com/v2/synthetics
description: Endpoint URL
variables:
REALM:
default: us0
description: Splunk Observability Cloud realm the organization is provisioned in (for example us0, us1, eu0, jp0, au0).
security:
- SessionToken: []
components:
securitySchemes:
SessionToken:
type: apiKey
in: header
name: X-SF-Token
description: Splunk Observability Cloud session token or org access token.
paths:
/cacerts:
get:
summary: getCaCertificates
description: 'Returns a list of Certificate Authority (CA) certificates.
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin, power, or read_only role.'
parameters:
- name: Content-Type
in: header
description: Format of the request body. Always "application/json".
required: true
schema:
type: string
- name: X-SF-TOKEN
in: header
description: Authentication token
required: true
schema:
type: string
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
properties:
cacerts:
type: array
items:
title: CaCertificateResponse
properties:
name:
type: string
example: foo
title: CertificateName
description: The name of your CA certificate.
description:
type: string
example: My awesome CA certificate
title: CertificateDescription
description: The description of your CA certificate.
filename:
type: string
example: ca_cert_file
title: CertificateFilename
description: The Filename of your CA certificate.
fileExtension:
type: string
example: pem
title: CertificateFileExtension
description: The File extension of your CA certificate.
createdAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:37.801Z'
title: CreatedAt
description: 'Timestamp of when the item was created, in UTC.
This field is read_only, and the system always sets the value.'
updatedAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:38.099Z'
title: UpdatedAt
description: 'Timestamp of when the item was last updated, in UTC.
This field is read_only, and the system always sets the value.'
createdBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: CreatedBy
description: 'Member ID of who created the item.
This field is read-only, and the system always sets the value.'
updatedBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: UpdatedBy
description: 'Member ID of who last updated the item.
This field is read-only, and the system always sets the value.'
id:
type: integer
format: int64
example: 1
title: CertificateId
description: The unique ID of the certificate.
content:
type: string
example: <REDACTED>
description: The content of the CA certificate.
expiresAt:
type: string
nullable: true
example: '2026-09-14T14:35:37.801Z'
title: CertificateExpiresAt
description: Timestamp of when the certificate will expire, in UTC.
required:
- name
- filename
- fileExtension
- content
- createdAt
- updatedAt
- createdBy
- updatedBy
- id
type: object
examples:
example:
value:
cacerts:
- content: <REDACTED>
createdAt: '2022-09-14T14:35:37.801Z'
createdBy: abcdefgh1234
description: My awesome CA certificate
expiresAt: '2026-09-14T14:35:37.801Z'
fileExtension: pem
filename: ca_cert_file
id: 1
name: foo
updatedAt: '2022-09-14T14:35:38.099Z'
updatedBy: abcdefgh1234
security:
- SessionToken: []
tags:
- Synthetics CA certificates
post:
summary: createCaCertificate
description: 'Creates a new CA certificate, based on the specifications in the request body.
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin or power role.'
parameters:
- name: Content-Type
in: header
description: Format of the request body. Always "application/json".
required: true
schema:
type: string
- name: X-SF-TOKEN
in: header
description: Authentication token.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cacert:
title: CaCertificateRequestBody
properties:
name:
type: string
example: foo
title: CertificateName
description: The name of your CA certificate.
description:
type: string
example: My awesome CA certificate
title: CertificateDescription
description: The description of your CA certificate.
filename:
type: string
example: ca_cert_file
title: CertificateFilename
description: The Filename of your CA certificate.
fileExtension:
type: string
example: pem
title: CertificateFileExtension
description: The File extension of your CA certificate.
createdAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:37.801Z'
title: CreatedAt
description: 'Timestamp of when the item was created, in UTC.
This field is read_only, and the system always sets the value.'
updatedAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:38.099Z'
title: UpdatedAt
description: 'Timestamp of when the item was last updated, in UTC.
This field is read_only, and the system always sets the value.'
createdBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: CreatedBy
description: 'Member ID of who created the item.
This field is read-only, and the system always sets the value.'
updatedBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: UpdatedBy
description: 'Member ID of who last updated the item.
This field is read-only, and the system always sets the value.'
content:
type: string
example: QmFnIEF0dHJpYnV0ZXMKICAgIGxvY2FsS2V5SUQ6IEY0IEVGIEVFIDU3IDE4IEU4IDE3IDczIEZBIDQ0IDI2IDZEIERCBFTkNSWVBURUQgUFJJVkFURSBLRVktLS0tLQo=
title: CertificateContent
description: Content of your CA certificate encoded in Base64.
required:
- name
- filename
- fileExtension
- content
- createdAt
- updatedAt
- createdBy
- updatedBy
type: object
examples:
example:
value:
cacert:
content: QmFnIEF0dHJpYnV0ZXMKICAgIGxvY2FsS2V5SUQ6IEY0IEVGIEVFIDU3IDE4IEU4IDE3IDczIEZBIDQ0IDI2IDZEIERCBFTkNSWVBURUQgUFJJVkFURSBLRVktLS0tLQo=
createdAt: '2022-09-14T14:35:37.801Z'
createdBy: abcdefgh1234
description: My awesome CA certificate
fileExtension: pem
filename: ca_cert_file
name: foo
updatedAt: '2022-09-14T14:35:38.099Z'
updatedBy: abcdefgh1234
responses:
'201':
description: HTTP 201 response
content:
application/json:
schema:
type: object
properties:
cacert:
title: CaCertificateResponse
properties:
name:
type: string
example: foo
title: CertificateName
description: The name of your CA certificate.
description:
type: string
example: My awesome CA certificate
title: CertificateDescription
description: The description of your CA certificate.
filename:
type: string
example: ca_cert_file
title: CertificateFilename
description: The Filename of your CA certificate.
fileExtension:
type: string
example: pem
title: CertificateFileExtension
description: The File extension of your CA certificate.
createdAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:37.801Z'
title: CreatedAt
description: 'Timestamp of when the item was created, in UTC.
This field is read_only, and the system always sets the value.'
updatedAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:38.099Z'
title: UpdatedAt
description: 'Timestamp of when the item was last updated, in UTC.
This field is read_only, and the system always sets the value.'
createdBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: CreatedBy
description: 'Member ID of who created the item.
This field is read-only, and the system always sets the value.'
updatedBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: UpdatedBy
description: 'Member ID of who last updated the item.
This field is read-only, and the system always sets the value.'
id:
type: integer
format: int64
example: 1
title: CertificateId
description: The unique ID of the certificate.
content:
type: string
example: <REDACTED>
description: The content of the CA certificate.
expiresAt:
type: string
nullable: true
example: '2026-09-14T14:35:37.801Z'
title: CertificateExpiresAt
description: Timestamp of when the certificate will expire, in UTC.
required:
- name
- filename
- fileExtension
- content
- createdAt
- updatedAt
- createdBy
- updatedBy
- id
type: object
examples:
example:
value:
cacert:
content: <REDACTED>
createdAt: '2022-09-14T14:35:37.801Z'
createdBy: abcdefgh1234
description: My awesome CA certificate
expiresAt: '2026-09-14T14:35:37.801Z'
fileExtension: pem
filename: ca_cert_file
id: 1
name: foo
updatedAt: '2022-09-14T14:35:38.099Z'
updatedBy: abcdefgh1234
'422':
description: HTTP 422 response
content:
application/json:
schema:
properties:
code:
type: string
example: unprocessable_entity
message:
type: string
example: Could not create CA Certificate
details:
type: object
properties:
name:
type: array
items:
type: string
example: is already taken
description: 'This is a dynamic schema that consists of:
"fieldName": ["reason"]'
type: object
examples:
example:
value:
code: unprocessable_entity
details:
name:
- is already taken
message: Could not create CA Certificate
security:
- SessionToken: []
tags:
- Synthetics CA certificates
/cacerts/{id}:
get:
summary: getSingleCaCertificate
description: 'Retrieves a single CA certificate.
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin, power, or read_only role.'
parameters:
- name: id
in: path
description: The ID of a CA certificate you want to retrieve.
required: true
schema:
type: integer
- name: X-SF-TOKEN
in: header
description: Authentication token.
required: true
schema:
type: string
responses:
'200':
description: HTTP 200 response
content:
application/json:
schema:
type: object
properties:
cacert:
title: CaCertificateResponse
properties:
name:
type: string
example: foo
title: CertificateName
description: The name of your CA certificate.
description:
type: string
example: My awesome CA certificate
title: CertificateDescription
description: The description of your CA certificate.
filename:
type: string
example: ca_cert_file
title: CertificateFilename
description: The Filename of your CA certificate.
fileExtension:
type: string
example: pem
title: CertificateFileExtension
description: The File extension of your CA certificate.
createdAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:37.801Z'
title: CreatedAt
description: 'Timestamp of when the item was created, in UTC.
This field is read_only, and the system always sets the value.'
updatedAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:38.099Z'
title: UpdatedAt
description: 'Timestamp of when the item was last updated, in UTC.
This field is read_only, and the system always sets the value.'
createdBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: CreatedBy
description: 'Member ID of who created the item.
This field is read-only, and the system always sets the value.'
updatedBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: UpdatedBy
description: 'Member ID of who last updated the item.
This field is read-only, and the system always sets the value.'
id:
type: integer
format: int64
example: 1
title: CertificateId
description: The unique ID of the certificate.
content:
type: string
example: <REDACTED>
description: The content of the CA certificate.
expiresAt:
type: string
nullable: true
example: '2026-09-14T14:35:37.801Z'
title: CertificateExpiresAt
description: Timestamp of when the certificate will expire, in UTC.
required:
- name
- filename
- fileExtension
- content
- createdAt
- updatedAt
- createdBy
- updatedBy
- id
type: object
examples:
example:
value:
cacert:
content: <REDACTED>
createdAt: '2022-09-14T14:35:37.801Z'
createdBy: abcdefgh1234
description: My awesome CA certificate
expiresAt: '2026-09-14T14:35:37.801Z'
fileExtension: pem
filename: ca_cert_file
id: 1
name: foo
updatedAt: '2022-09-14T14:35:38.099Z'
updatedBy: abcdefgh1234
'404':
description: HTTP 404 response
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: not_found
message:
type: string
example: Record not found
details:
type: object
example: '{}'
title: NotFound
description: Not Found
examples:
example:
value:
code: not_found
details: '{}'
message: Record not found
security:
- SessionToken: []
tags:
- Synthetics CA certificates
put:
summary: updateSingleCaCertificate
description: 'Update an existing CA certificate
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin or power role.'
parameters:
- name: id
in: path
description: The ID of the CA certificate you are updating
required: true
schema:
type: integer
example: 1
- name: Content-Type
in: header
description: Format of the request body. Always "application/json".
required: true
schema:
type: string
- name: X-SF-TOKEN
in: header
description: Authentication token.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cacert:
title: CaCertificateRequestBody
properties:
name:
type: string
example: foo
title: CertificateName
description: The name of your CA certificate.
description:
type: string
example: My awesome CA certificate
title: CertificateDescription
description: The description of your CA certificate.
filename:
type: string
example: ca_cert_file
title: CertificateFilename
description: The Filename of your CA certificate.
fileExtension:
type: string
example: pem
title: CertificateFileExtension
description: The File extension of your CA certificate.
createdAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:37.801Z'
title: CreatedAt
description: 'Timestamp of when the item was created, in UTC.
This field is read_only, and the system always sets the value.'
updatedAt:
type: string
readOnly: true
writeOnly: false
example: '2022-09-14T14:35:38.099Z'
title: UpdatedAt
description: 'Timestamp of when the item was last updated, in UTC.
This field is read_only, and the system always sets the value.'
createdBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: CreatedBy
description: 'Member ID of who created the item.
This field is read-only, and the system always sets the value.'
updatedBy:
type: string
readOnly: true
writeOnly: false
example: abcdefgh1234
title: UpdatedBy
description: 'Member ID of who last updated the item.
This field is read-only, and the system always sets the value.'
content:
type: string
example: QmFnIEF0dHJpYnV0ZXMKICAgIGxvY2FsS2V5SUQ6IEY0IEVGIEVFIDU3IDE4IEU4IDE3IDczIEZBIDQ0IDI2IDZEIERCBFTkNSWVBURUQgUFJJVkFURSBLRVktLS0tLQo=
title: CertificateContent
description: Content of your CA certificate encoded in Base64.
required:
- name
- filename
- fileExtension
- content
- createdAt
- updatedAt
- createdBy
- updatedBy
type: object
examples:
example:
value:
cacert:
content: QmFnIEF0dHJpYnV0ZXMKICAgIGxvY2FsS2V5SUQ6IEY0IEVGIEVFIDU3IDE4IEU4IDE3IDczIEZBIDQ0IDI2IDZEIERCBFTkNSWVBURUQgUFJJVkFURSBLRVktLS0tLQo=
createdAt: '2022-09-14T14:35:37.801Z'
createdBy: abcdefgh1234
description: My awesome CA certificate
fileExtension: pem
filename: ca_cert_file
name: foo
updatedAt: '2022-09-14T14:35:38.099Z'
updatedBy: abcdefgh1234
responses:
'200':
description: HTTP 200 response
'404':
description: HTTP 404 response
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: not_found
message:
type: string
example: Record not found
details:
type: object
example: '{}'
title: NotFound
description: Not Found
examples:
example:
value:
code: not_found
details: '{}'
message: Record not found
'422':
description: HTTP 422 response
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: unprocessable_entity
message:
type: string
example: Could not process Ca certificate
details:
type: object
properties:
name:
type: array
items:
type: string
example: is already taken
description: 'This is a dynamic schema that consists of:
"fieldName": ["reason"]'
title: UnprocessableEntity
description: UnprocessableEntity
examples:
example:
value:
code: unprocessable_entity
details:
name:
- is already taken
message: Could not process Ca certificate
security:
- SessionToken: []
tags:
- Synthetics CA certificates
delete:
summary: deleteCaCertificate
description: 'Deletes a CA certificate
Requirements
You must have an organization access token with the API permission or a session token to use the API.
You need the Splunk Observability Cloud admin or power role.'
parameters:
- name: id
in: path
description: The ID of a CA certificate
required: true
schema:
type: string
- name: X-SF-TOKEN
in: header
description: Authentication token.
required: true
schema:
type: string
responses:
'204':
description: HTTP 204 response
'404':
description: HTTP 404 response
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: not_found
message:
type: string
example: Record not found
details:
type: object
example: '{}'
title: NotFound
description: Not Found
examples:
example:
value:
code: not_found
details: '{}'
message: Record not found
security:
- SessionToke
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/splunk-observability/refs/heads/main/openapi/splunk-observability-synthetics-ca-certs-openapi.yml