List secrets

GET /cloud/v1/secrets/{project_id}/{region_id}

Try it

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.secrets.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.id)

200

{
  "count": 1,
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "secret_type": "certificate",
      "status": "<string>",
      "algorithm": "aes",
      "bit_length": 256,
      "content_types": {
        "default": "application/octet-stream"
      },
      "created": "2023-03-23T20:00:00+00:00",
      "expiration": "2023-06-23T20:00:00+00:00",
      "mode": "cbc"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

region_id · integer · required

Region ID

Query Parameters

limit · integer · default: 1000

Optional. Limit the number of returned items

Required range: x <= 1000

offset · integer · default: 0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

results · SecretSerializer · object[] · required

Objects

Show child attributes

results. id · string · required

Secret uuid

results. name · string · required

Secret name

results. secret_type · enum<string> · required

Secret type, base64 encoded. symmetric - Used for storing byte arrays such as keys suitable for symmetric encryption; public - Used for storing the public key of an asymmetric keypair; private - Used for storing the private key of an asymmetric keypair; passphrase - Used for storing plain text passphrases; certificate - Used for storing cryptographic certificates such as X.509 certificates; opaque - Used for backwards compatibility with previous versions of the API

Available options: certificate, opaque, passphrase, private, public, symmetric

results. status · string · required

Status

results. algorithm · string | null

Metadata provided by a user or system for informational purposes. Defaults to None

Example:

"aes"

results. bit_length · integer | null

Metadata provided by a user or system for informational purposes. Value must be greater than zero. Defaults to None

Example:

256

results. content_types · Content Types · object

Describes the content-types that can be used to retrieve the payload. The content-type used with symmetric secrets is application/octet-stream

Show child attributes

results.content_types. {key} · string

Example:

{ "default": "application/octet-stream" }

results. created · string<date-time> | null

Datetime when the secret was created. The format is 2020-01-01T12:00:00+00:00

Example:

"2023-03-23T20:00:00+00:00"

results. expiration · string<date-time> | null

Datetime when the secret will expire. The format is 2020-01-01T12:00:00+00:00. Defaults to None

Example:

"2023-06-23T20:00:00+00:00"

results. mode · string | null

Metadata provided by a user or system for informational purposes. Defaults to None

Example:

"cbc"