Type Alias GetObjectStorageKeyResponses

Type Declaration

• access_key: string

  A unique string chosen by the API to identify this key. Used as a username to identify this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

• bucket_access: {
      bucket_name: string;
      cluster: string;
      permissions: "read_write" | "read_only";
      region: string;
  }[]

  Settings that limit access to specific buckets, each with a specific permission level. See Create a limited access key for more information.

• id: number

  This Object Storage key's unique ID.

• label: string

  The label given to this key. For display purposes only.

• limited: boolean

  Whether this Object Storage key limits access to specific buckets and permissions. Returns false if this key grants full access. Specific limitations are set in bucket_access.

• regions: { endpoint_type: "E0" | "E1" | "E2" | "E3"; id: string; s3_endpoint: string }[]

  The key can be used in these regions to manage buckets.

• secret_key: string

  This Object Storage key's secret key. Used as a password to validate this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

  📘

  This value is listed as [REDACTED] for this operation, to protect it. It's only revealed in a response after creating a key.