Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - DeployedExpiredCertificate

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

DeployedExpiredCertificate

The Deployed Expired Certificate object provides access to the deployed X.509 certificate information used to populate the Certificates panel on the Runtime Management page. In addition, querying the Deployed Expired Certificate object enables programmatic generation of alerts of expiring certificates so you can manage certificates easier.

Required Privileges

You need these privileges in the target environment:

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.

Queries for a DeployedExpiredCertificate object(s)

If a QUERY omits an explicit timespan filter — that is, the query does not use expirationBoundary in an expression — it applies a default timespan filter using the value of 30 and the LESS_THAN operator. This filter specifies expired certificates and certificates expiring within 30 days.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: containerId, containerName, environmentId, environmentName, expirationBoundary

required
object
required
DeployedExpiredCertificateSimpleExpression (object) or DeployedExpiredCertificateGroupingExpression (object) (DeployedExpiredCertificateExpression)
One of
operator
required
string
Value: "LESS_THAN_OR_EQUAL"
property
required
string
Enum: "containerId" "containerName" "environmentId" "environmentName" "expirationBoundary"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (DeployedExpiredCertificate)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 100,
  • "@type": "QueryResult"
}

Retrieves additional results for a DeployedExpiredCertificate query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (DeployedExpiredCertificate)

Response samples

Content type
{
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 100,
  • "@type": "QueryResult"
}