STACKIT

STACKIT Key Management Service API

This API provides endpoints for managing keys and key rings.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This API provides endpoints for managing keys and key rings.

Endpoints 25

  • GETList key rings/v1/projects/:projectId/regions/:regionId/keyringsReturns a list of all key rings within the project.
  • POSTCreate key ring/v1/projects/:projectId/regions/:regionId/keyringsCreates a new key ring within the project.
  • GETGet key ring/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingIdReturns the details for the given key ring.
  • DELETEDelete keyring/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingIdDeletes the given key ring if it is empty
  • GETList keys/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keysReturns the keys for the given key ring.
  • POSTCreate key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keysCreates a new key for the given key ring.
  • GETGet key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyIdReturns the details for the given key.
  • DELETEDelete key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyIdSchedules the deletion of the given key
  • POSTImport key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/importImports a new version to the given key.
  • POSTRestore deleted key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/restoreRestores the given key from being deleted.
  • POSTRotate key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/rotateRotates the given key.
  • GETList versions/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versionsReturns a list of all versions of a given key.
  • GETGet version/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumberReturns the details for the given version.
  • POSTDecrypt/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/decryptDecrypts data using the given key version.
  • POSTDestroy version/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/destroyRemoves the key material of a version permanently.
  • POSTDisable version/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/disableDisables the given version.
  • POSTEnable version/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/enableEnables the given version.
  • POSTEncrypt/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/encryptEncrypts data using the given key version.
  • POSTRestore version/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/restoreRestores the given version from being destroyed
  • POSTSign/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/signSign data using the given key version as secret.
  • POSTVerify/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/keys/:keyId/versions/:versionNumber/verifyVerify data using the given key version as secret.
  • GETList wrapping keys/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/wrappingkeysReturns the wrapping keys for the given key ring.
  • POSTCreate wrapping key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/wrappingkeysCreates a new wrapping key for the given key ring.
  • GETGet wrapping key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/wrappingkeys/:wrappingKeyIdReturns the details for the given wrapping key.
  • DELETEDelete wrapping key/v1/projects/:projectId/regions/:regionId/keyrings/:keyRingId/wrappingkeys/:wrappingKeyIdDeletes the given wrapping key

API details

Base URL
https://kms.api.stackit.cloud
Authentication
None declared in the description
Operations
25 operations on 19 pathsPOST 14GET 8DELETE 3
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 1.0.0

How to test the STACKIT Key Management Service API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT Key Management Service API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List key rings” (GET /v1/projects/:projectId/regions/:regionId/keyrings), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the STACKIT Key Management Service API?

This API provides endpoints for managing keys and key rings. It is listed under Developer tools and has 25 endpoints.

Who publishes the STACKIT Key Management Service API?

It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.

What is the base URL of the STACKIT Key Management Service API?

Requests go to https://kms.api.stackit.cloud. Endpoint paths are added to this base URL.

How do I authenticate with the STACKIT Key Management Service API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the STACKIT Key Management Service API have?

25 operations on 19 paths (14 POST, 8 GET, 3 DELETE).

Is forking the STACKIT Key Management Service API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.