ApplicationRegistration

object

A application’s registration for a specific version of an API.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.

Allowed values:approvedpendingrevokedrejected

Example:approved

apiobjectrequired

Details about the API the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired

Details about the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ApplicationRegistrationStatus

string

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.

Allowed values:approvedpendingrevokedrejected

Example

PortalCustomDomain

object
* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
cname_statusstringrequiredread-only

Allowed values:verifiedpending

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

PortalCustomDomainSSL

object
* Additional properties are NOT allowed.
domain_verification_methodstringrequired

Allowed values:httpcustom_certificate

verification_statusstringrequiredread-only

Allowed values:verifiedpendingerror

validation_errorsarray[string]read-only
uploaded_atstring(date-time)read-only

An ISO-8601 timestamp representation of the ssl certificate upload date.

Example:2022-11-04T20:10:06.927Z

expires_atstring(date-time)read-only

An ISO-8601 timestamp representation of the ssl certificate expiration date.

Example:2022-11-04T20:10:06.927Z

skip_ca_checkbooleanread-only

True when the provided certificate chain is served as-is without validation against a public trust store.

Example

UpdatePortalCustomDomainSSL

object
* Additional properties are NOT allowed.
custom_certificatestring

Custom certificate to be used for the SSL termination.

custom_private_keystring

Custom certificate private key to be used for the SSL termination.

skip_ca_checkboolean

Advanced option. If true, the custom certificate is served exactly as provided, without attempting to bundle against a public trust store. Required for certificates issued by an internal/private CA.

Default:false

Example