Skip to main content
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

List all certificates

Contributeurs
PDF

GET /accounts/{account_id}/core/v1/certificates

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

continue

query

False

Indicates the token to resume listing from.

URL examples: "continue="

OpenAPI examples: ""</continue>

filter

string

query

False

Indicates which fields should be matched in order to return a resource when listing a collection.

Supported operators are:

  • eq - Equality

  • lt/gt - Less than/Greater than

  • lte/gte - Less than or equals to/Greater than or equals to

URL example: "filter=field%20eq%20%27value%27"

OpenAPI examples: "field eq 'value'"

  • example: certUse%20eq%20'rootCA'

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

  • example: id,cn,isSelfSigned

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

orderBy

string

query

False

Indicates the sort order of resource when listing a collection.

URL examples: "orderBy=name", "orderBy=name%20desc"

OpenAPI examples: "name desc"

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name Type Required Description

items

array[Any of: certificate_1.0_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True
Example response 
{
  "type": "application/astra-certificates",
  "version": "1.0",
  "items": [
    [
      "f97f3441-075e-4f9b-9d1e-47f9f62a3fc4",
      "prod.region-1.example.com",
      "true"
    ],
    [
      "5e365b4d-034f-4f13-95ef-d3a7fbc0df3d",
      "prod.region-2.example.com",
      "false"
    ],
    [
      "11ceb350-1999-4b79-80a6-46a980a27856",
      "prod.example.com",
      "false"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_stateTransitions

Name Type Required Description

from

string

True

to

array[string]

True

type_astra_stateDetails

Name Type Required Description

type

string

True

title

string

True

detail

string

True

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name Type Required Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

certificate_1.0_get_response_body

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-certificate"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

certUse

string

True

JSON string indicating the use of the certificate. If not specified, defaults to "rootCA". Defined values are:

  • "rootCA" - The certificate is a certificate authority (CA) certificate used to trust any certificate signed by that CA.

  • "intermediateCA" - The certificate is an intermediate CA certificate issued by a root CA.

cert

string

True

JSON string containing a Base64 encoded PKCS-11 formatted certificate (PEM). Defined values are:

  • Conforms to the base64 Encoded Data Schema

cn

string

True

JSON string containing a common name extracted from the certificate. Defined values are:

  • Minimum length: 1

  • Maximum length: 511

expiryTimestamp

string

True

JSON string containing a timestamp indicating when the certificate expires. Defined values are:

  • Conforms to the ISO-8601 Date Time Schema

isSelfSigned

string

True

JSON string indicating whether the certificate is self-signed. If not provided on create, the value defaults to "false". On update:

  • If the value is provided, that value will be used.

  • If the value is not provided and the "cert" field is included in the update, the value will be set to "false".

  • If the value is not provided and the "cert" field is not included in the update, the existing value will be retained. Defined values are:

  • "true" - The certificate is self-signed.

  • "false" - The certificate is not self-signed.

trustState

string

True

JSON string containing one of a set of enumerated values indicating whether the certificate is trusted. Defined values are:

  • "untrusted" - The certificate is not trusted.

  • "trusted" - The certificate is marked as trusted.

  • "expired" - The certificate is expired, so is neither trusted or not trusted.

trustStateTransitions

array[type_astra_stateTransitions]

True

JSON array of JSON objects, each representing the set of permitted state transitions from a given defined state. Each JSON object contains the fields "from" and "to", where the "from" value is the name of a state, and the "to" value is an array of permitted destination states.

trustStateDesired

string

False

JSON string containing a value indicating whether the certificate is trusted. If not specified on create, the default value is "trusted". Defined values are:

  • "untrusted" - The certificate is not trusted.

  • "trusted" - The certificate is marked as trusted.

trustStateDetails

array[type_astra_stateDetails]

True

JSON array of JSON objects that lists additional details about the trust state of the certificate. If no details are available, this array will be empty.

  • Minimum Items: 0

metadata

type_astra_metadata_update

True

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

type_astra_metadata_list

Name Type Required Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid