@akamai/openapi-ts
    Preparing search index...

    Type Alias PutObjectStorageKeyResponses

    type PutObjectStorageKeyResponses = {
        "200": {
            access_key: string;
            id: number;
            label: string;
            limited: boolean;
            regions: {
                endpoint_type: "E0" | "E1" | "E2" | "E3";
                id: string;
                s3_endpoint: string;
            }[];
            secret_key: string;
        };
    }
    Index

    Properties

    Properties

    "200": {
        access_key: string;
        id: number;
        label: string;
        limited: boolean;
        regions: {
            endpoint_type: "E0" | "E1" | "E2" | "E3";
            id: string;
            s3_endpoint: string;
        }[];
        secret_key: string;
    }

    An updated Object Storage key used for authentication.

    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.

    • id: number

      This Object Storage key's unique numeric identifier.

    • 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.

      📘

      The bucket_access array that contains limited Object Storage key settings doesn't appear in this response. Store this key's id from the response and run Get an Object Storage key to view these settings.

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

      The key can be used in these regions to list buckets and create new ones, but it can't be used to manage content in the newly created buckets. See Create an unlimited access key for more information.

    • 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.