Skip to main content

List CertificateObjects

GET 
/v1/config/rulestacks/:rulestackname/certificates

Returns the list of certificate objects associated with the specified rulestack.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

Query Parameters

    nexttoken Nexttoken

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

    If the number of certificate objects available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of certificate objects, use this token in your next request.

    candidate Candidate

    Default value: true

    Certificate object candidate.

    running Running

    Certificate objects in run state.

    uncommitted Uncommitted

    Uncommitted certificate objects.

    maxresults Maxresults

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of certificate objects that you want NGFW to return for this request.

Responses​

OK

Schema
    Response object

    The API call response.

    CertificateObjectCandidate string[]

    Certificate object candidate.

    CertificateObjectRunning string[]

    Certificate objects on run state.

    CertificateObjectUncommitted object[]

    Uncommitted certificate objects.

  • Array [
    • Name Name (string)required

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9-]+$

    Name of the certificate object.

    Operation Operation (string)required

    Certificate object operation.

  • ]
    • NextToken Nexttoken (string)

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

    If the number of certificate objects available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of certificate objects, use this token in your next request.

    RuleStackName Rulestackname (string)

    Name of the rulestack.

    ResponseStatus object

    The API call response status.

    ErrorCode Errorcode (integer)

    Default value: 0

    Default value of a successful response is 0. Any other number indicates an error code.

    400—HTTP bad request

    • InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.
    • ResourceNotFoundException—Unable to locate a resource using the parameters you provided.
    • ThrottlingException—Operation failed due to throttling limitations.

    500—Bad request

    • InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.
    Reason Reason (string)

    The error description.

Loading...