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

IBM API Keys API

Create and manage API keys for users and service IDs

IBM API Keys API is one of 55 APIs that IBM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include API Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, pricing, and 1 JSON Schema.

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

Requests are made against a single base URL, https://iam.cloud.ibm.com.

10 operations 5 paths 8 schemas 3 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.us-south.assistant.watson.cloud.ibm.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

IBM API Keys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — IAM access token obtained from the /identity/token endpoint. Pass as Authorization: Bearer .

Paths & Operations 10

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

API Keys 10

Create and manage API keys for users and service IDs

GET
/v1/apikeys
List API keys
listApiKeys 8 params → 200401
POST
/v1/apikeys
Create an API key
createApiKey body → 201400401
GET
/v1/apikeys/details
Get API key details by value
getApiKeysDetails 2 params → 200401404
GET
/v1/apikeys/{id}
Get an API key
getApiKey 3 params → 200401404
PUT
/v1/apikeys/{id}
Update an API key
updateApiKey 2 params body → 200400404409
DELETE
/v1/apikeys/{id}
Delete an API key
deleteApiKey 1 param → 204401404
POST
/v1/apikeys/{id}/lock
Lock an API key
lockApiKey 1 param → 200401404
DELETE
/v1/apikeys/{id}/lock
Unlock an API key
unlockApiKey 1 param → 200401404
POST
/v1/apikeys/{id}/disable
Disable an API key
disableApiKey 1 param → 200401404
DELETE
/v1/apikeys/{id}/disable
Enable an API key
enableApiKey 1 param → 200401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ApiKey (17 properties), ResponseContext (11 properties), CreateApiKeyRequest (9 properties), ApiKeyList (7 properties). Each schema is shown below with its type and property counts.

ResponseContext
object
Context metadata for paginated API responses.
11 properties
ApiKeyList
object
A paginated list of API keys.
7 properties
CreateApiKeyRequest
object
Request body for creating an API key.
9 properties 2 required
ApiKey
object
An IAM API key used for authentication.
17 properties
ErrorResponse
object
An error response from the IAM API.
4 properties
Activity
object
Activity information for an identity resource.
2 properties
ActivityEntry
object
A history entry for an identity resource.
6 properties
UpdateApiKeyRequest
object
Request body for updating an API key.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-api-keys-api-openapi.yml Raw ↑

Other APIs IBM publishes across the network.

IBM Cloud Object Storage
IBM Cloud Databases for PostgreSQL
IBM Cloud Code Engine
IBM watsonx.ai
IBM watsonx.governance
IBM Watson Discovery
IBM Cloud Virtual Private Cloud
IBM Cloud Kubernetes Service
IBM Key Protect
IBM Cloud Secrets Manager
IBM Cloud Event Notifications
IBM Cloud Container Registry