---
title: "Get an SDK key's metadata"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Feature Flags API

`GET /v1/organizations/{orgId}/projects/{projectId}/environments/{environmentId}/sdk-keys/{sdkKeyId}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetSdkKey.path.orgId` (string, required)
  - format `uuid`
- `GetSdkKey.path.projectId` (string, required)
  - format `uuid`
- `GetSdkKey.path.environmentId` (string, required)
  - format `uuid`
- `GetSdkKey.path.sdkKeyId` (string, required)
  - format `uuid`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/sdk-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/sdk-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/sdk-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The SDK key.

#### Example

```json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "server",
  "name": "string",
  "prefix": "string",
  "resourceName": "string",
  "revokedAt": "2019-08-24T14:15:22Z"
}
```

- `GetSdkKey.response.200.createdAt` (string, required)
  - format `date-time`
- `GetSdkKey.response.200.environmentId` (string, required)
  - format `uuid`
- `GetSdkKey.response.200.id` (string, required)
  - format `uuid`
- `GetSdkKey.response.200.kind` (unknown, required) — server: secret, for backends; client: publishable, for web frontends (clientSide flags only).
  - one of `"server"`, `"client"`
- `GetSdkKey.response.200.name` (string, required)
  - maxLength 100
- `GetSdkKey.response.200.prefix` (string, required) — The key's first 12 characters, to recognise it (ezgh_fs_Ab3d).
- `GetSdkKey.response.200.resourceName` (string, required)
- `GetSdkKey.response.200.revokedAt` (string | null, required)
  - format `date-time`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.400.error` (object, required)
  - `GetSdkKey.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.400.error.issues.message` (string, required)
    - `GetSdkKey.response.400.error.issues.path` (string, required)
  - `GetSdkKey.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.400.error.quota.id` (string, required)
    - `GetSdkKey.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.400.error.quota.region` (string, optional)
    - `GetSdkKey.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.401.error` (object, required)
  - `GetSdkKey.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.401.error.issues.message` (string, required)
    - `GetSdkKey.response.401.error.issues.path` (string, required)
  - `GetSdkKey.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.401.error.quota.id` (string, required)
    - `GetSdkKey.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.401.error.quota.region` (string, optional)
    - `GetSdkKey.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.403.error` (object, required)
  - `GetSdkKey.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.403.error.issues.message` (string, required)
    - `GetSdkKey.response.403.error.issues.path` (string, required)
  - `GetSdkKey.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.403.error.quota.id` (string, required)
    - `GetSdkKey.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.403.error.quota.region` (string, optional)
    - `GetSdkKey.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.404.error` (object, required)
  - `GetSdkKey.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.404.error.issues.message` (string, required)
    - `GetSdkKey.response.404.error.issues.path` (string, required)
  - `GetSdkKey.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.404.error.quota.id` (string, required)
    - `GetSdkKey.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.404.error.quota.region` (string, optional)
    - `GetSdkKey.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.429.error` (object, required)
  - `GetSdkKey.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.429.error.issues.message` (string, required)
    - `GetSdkKey.response.429.error.issues.path` (string, required)
  - `GetSdkKey.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.429.error.quota.id` (string, required)
    - `GetSdkKey.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.429.error.quota.region` (string, optional)
    - `GetSdkKey.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.500.error` (object, required)
  - `GetSdkKey.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.500.error.issues.message` (string, required)
    - `GetSdkKey.response.500.error.issues.path` (string, required)
  - `GetSdkKey.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.500.error.quota.id` (string, required)
    - `GetSdkKey.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.500.error.quota.region` (string, optional)
    - `GetSdkKey.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetSdkKey.response.503.error` (object, required)
  - `GetSdkKey.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetSdkKey.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetSdkKey.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetSdkKey.response.503.error.issues.message` (string, required)
    - `GetSdkKey.response.503.error.issues.path` (string, required)
  - `GetSdkKey.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetSdkKey.response.503.error.quota.id` (string, required)
    - `GetSdkKey.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetSdkKey.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetSdkKey.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetSdkKey.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetSdkKey.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.503.error.quota.region` (string, optional)
    - `GetSdkKey.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetSdkKey.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetSdkKey.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetSdkKey.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/flags-api/GetSdkKey/index.md