AWS virtual keys

List AWS Virtual Keys

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

project*string

Filter by project ID or name.

Lengthlength <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/aws-virtual-keys?project=my-project"

{  "virtualKeys": [    {      "id": "vkey_0p9nwqgtftugsoey99lqyqq",      "projectId": "string",      "status": "provisioning",      "externalKeyId": "string",      "awsAccountId": "string",      "awsRegion": "string",      "customKeyStoreId": "string",      "kmsKeyArn": "string",      "alias": "string",      "description": "string",      "deletionWindowDays": 0,      "tags": {        "property1": "string",        "property2": "string"      },      "observedAt": "2019-08-24T14:15:22Z",      "canaryPassedAt": "2019-08-24T14:15:22Z",      "deletionScheduledAt": "2019-08-24T14:15:22Z",      "finalDeletionObservedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Create AWS Virtual Key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project?ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

selector*|

awsAccountId*string

Match^\d{12}$

awsRegion*string

Match^[a-z]{2}(?:-gov)?-[a-z]+-\d$

idempotencyKey*string

Length1 <= length <= 128

alias?|

Length1 <= length <= 256

description?|

Lengthlength <= 8192

deletionWindowDays?integer

Range7 <= value <= 30

Default30

tags?

Default{}

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys" \  -H "Content-Type: application/json" \  -d '{    "selector": {      "externalId": "ext_example_01"    },    "awsAccountId": "string",    "awsRegion": "string",    "idempotencyKey": "string"  }'

{  "virtualKey": {    "id": "vkey_0p9nwqgtftugsoey99lqyqq",    "projectId": "string",    "status": "provisioning",    "externalKeyId": "string",    "awsAccountId": "string",    "awsRegion": "string",    "customKeyStoreId": "string",    "kmsKeyArn": "string",    "alias": "string",    "description": "string",    "deletionWindowDays": 0,    "tags": {      "property1": "string",      "property2": "string"    },    "observedAt": "2019-08-24T14:15:22Z",    "canaryPassedAt": "2019-08-24T14:15:22Z",    "deletionScheduledAt": "2019-08-24T14:15:22Z",    "finalDeletionObservedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "setup": {    "proxyUriEndpoint": "http://example.com",    "proxyUriPath": "string",    "accessKeyId": "string",    "secretAccessKey": "string",    "externalKeyId": "string"  }}

Rotate AWS Virtual Key Credential

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

generation*integer

Range2 <= value

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/rotate-credential" \  -H "Content-Type: application/json" \  -d '{    "generation": 2  }'

{  "virtualKey": {    "id": "vkey_0p9nwqgtftugsoey99lqyqq",    "projectId": "string",    "status": "provisioning",    "externalKeyId": "string",    "awsAccountId": "string",    "awsRegion": "string",    "customKeyStoreId": "string",    "kmsKeyArn": "string",    "alias": "string",    "description": "string",    "deletionWindowDays": 0,    "tags": {      "property1": "string",      "property2": "string"    },    "observedAt": "2019-08-24T14:15:22Z",    "canaryPassedAt": "2019-08-24T14:15:22Z",    "deletionScheduledAt": "2019-08-24T14:15:22Z",    "finalDeletionObservedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "setup": {    "proxyUriEndpoint": "http://example.com",    "proxyUriPath": "string",    "accessKeyId": "string",    "secretAccessKey": "string",    "externalKeyId": "string"  }}

Restore AWS Virtual Key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/restore" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Finalize AWS Virtual Key Deletion

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/finalize-deletion" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Decommission AWS Virtual Key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

deletionScheduledAt*string

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/decommission" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string",    "deletionScheduledAt": "2019-08-24T14:15:22Z"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get AWS Virtual Key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Response Body

`application/json`

curl -X GET "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq"

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Continue AWS Virtual Key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the aws virtual key.

Matchvkey_[0-9a-z]{28}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customKeyStoreId*string

Match^cks-[A-Za-z0-9]+$

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/continue" \  -H "Content-Type: application/json" \  -d '{    "customKeyStoreId": "string",    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List AWS Virtual KeysCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

Create AWS Virtual KeyCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

404application/json

409application/json

500application/json

503application/json

Rotate AWS Virtual Key CredentialCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

409application/json

Restore AWS Virtual KeyCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

409application/json

Finalize AWS Virtual Key DeletionCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

409application/json

Decommission AWS Virtual KeyCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

404application/json

409application/json

Get AWS Virtual KeyCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

Continue AWS Virtual KeyCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

404application/json

409application/json

List AWS Virtual Keys

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Create AWS Virtual Key

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Rotate AWS Virtual Key Credential

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Restore AWS Virtual Key

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Finalize AWS Virtual Key Deletion

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Decommission AWS Virtual Key

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Get AWS Virtual Key

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

Continue AWS Virtual Key

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`