dots.v2.spaces.keys.byAccess_key().get()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Usage

client.v2.spaces.keys.byAccess_key(access_key).get(requestConfiguration?: RequestConfiguration<object>): Promise<undefined | WithAccess_keyGetResponse>

Description

To get a Spaces Access Key, send a GET request to /v2/spaces/keys/{access_key}.

A successful request will return the Access Key.

Parameters

access_key string required

Example: DOACCESSKEYEXAMPLE

The access key's ID.

Request Sample

Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.spaces.keys
    .byAccess_key("DOACCESSKEYEXAMPLE").get();

Response Example

Show Response Example
{
  "key": {
    "name": "read-only-key",
    "access_key": "DOACCESSKEYEXAMPLE",
    "grants": [
      {
        "bucket": "my-bucket",
        "permission": "read"
      }
    ],
    "created_at": "2018-07-19T15:04:16Z"
  }
}

More Information

See /v2/spaces/keys/{access_key} in the API reference for additional detail on responses, headers, parameters, and more.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.