Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IronCore Labs KMS Configuration API

KMS configurations from different providers (AWS, Azure, GCP, Thales)

IronCore Labs KMS Configuration API is one of 5 APIs that IronCore Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include KMS Configuration. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 3.1.0.

Requests are made against a single base URL, http://localhost:3000/api.

5 operations 2 paths 26 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.1.0
Base URL
https://ironcorelabs.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IronCore Labs KMS Configuration API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

  • Authorization — VAB authorization header. Form: vab:1:

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

KMS Configuration 5

KMS configurations from different providers (AWS, Azure, GCP, Thales)

GET
/1/kms/configs
KMS Config List
get-kms-configs 7 params → 200401
POST
/1/kms/configs
KMS Config Create
post-kms-configs 1 param body → 200401
GET
/1/kms/configs/{kmsConfigId}
KMS Config Get
get-kms-configs-kmsConfigId 2 params → 200401422
PUT
/1/kms/configs/{kmsConfigId}
KMS Config Update
put-kms-configs-kmsConfigId 2 params body → 200401422
DELETE
/1/kms/configs/{kmsConfigId}
KMS Config Delete
delete-kms-configs-kmsConfigId 2 params → 200401422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BasicKmsConfig (9 properties), AzureKmsConfig (4 properties), ThalesKmsConfig (4 properties), GcpKmsConfig (4 properties). Each schema is shown below with its type and property counts.

AzureKmsConfigUpdate
object
Azure configuration update. keyPath cannot be updated
3 properties 3 required
AwsKmsConfigUpdate
object
AWS configuration update. keyPath cannot be updated
3 properties 3 required
GcpKmsConfigUpdate
object
GCP configuration update. keyPath cannot be updated
3 properties 3 required
Base64
string
Base 64 string
AwsCredentialsV1
object
AWS credentials
2 properties 2 required
KmsConfigId
integer
KMS configuration ID
ThalesCredentialsV1
object
Thales credentials
4 properties 4 required
CreatedByType
string
Creator type
AwsKmsConfigNonsensitive
object
AWS configuration without sensitive credentials
3 properties 3 required
AzureKmsConfigNonsensitive
object
Azure configuration without sensitive credentials
3 properties 3 required
AwsKmsConfig
object
AWS configuration
4 properties 4 required
KmsConfigurationUpdate
KMS configuration update. keyPath cannot be updated
ThalesKmsConfig
object
Thales configuration
4 properties 4 required
ThalesKmsConfigUpdate
object
Thales configuration update. keyPath cannot be updated
3 properties 3 required
AzureKmsConfig
object
Azure configuration
4 properties 4 required
BasicKmsConfig
object
KMS Configuration metadata
9 properties 9 required
CreatedBy
object
Metadata about creating user/service
3 properties 3 required
GcpKmsConfigNonsensitive
object
GCP configuration without sensitive credentials
3 properties 3 required
GcpCredentialsV1
object
GCP credentials
2 properties 2 required
KmsType
string
KMS type: AWS, Azure, or GCP
ThalesKmsConfigNonsensitive
object
Thales configuration without sensitive credentials
3 properties 3 required
AzureCredentialsV1
object
Azure credentials
3 properties 3 required
GcpKmsConfig
object
GCP configuration
4 properties 4 required
Timestamp
string
RFC3339 timestamp
KmsConfiguration
KMS configuration
KmsConfigurationNonsensitive
KMS configuration without sensitive credentials

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironcore-labs-kms-configuration-api-openapi.yml Raw ↑

Other APIs IronCore Labs publishes across the network.

IronCore Labs Configuration Assignment API
IronCore Labs Tag API
IronCore Labs Tenant API
IronCore Labs Tenant Secret API