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

Terminal Use API Keys API

The API Keys API from Terminal Use — 3 operation(s) for api keys.

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

Tagged areas include API Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.terminaluse.com.

6 operations 3 paths 11 schemas 1 DELETE2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.terminaluse.com
Resource Areas
1

Paths & Operations 6

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

API Keys 6
GET
/api_keys
List API Keys
api_keys_list 1 param → 200422
POST
/api_keys
Create API Key
api_keys_create body → 201422
DELETE
/api_keys/{api_key_id}
Revoke API Key
api_keys_delete 1 param → 200422
GET
/api_keys/{api_key_id}
Get API Key
api_keys_retrieve 1 param → 200422
PATCH
/api_keys/{api_key_id}
Update API Key Scopes
api_keys_update_scopes 1 param body → 200422
PATCH
/api_keys/{api_key_id}/sharing-groups
Update API Key Sharing Groups
api_keys_update_sharing_groups 1 param body → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ApiKeyResponse (11 properties), ApiKeyCreateRequest (4 properties), ApiKeyScope (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

ApiKeyScope
object
Scope definition for an API key - defines resource and role access.
3 properties 3 required
ApiKeyScopesUpdateRequest
object
Request model for updating API key scopes.
1 property 1 required
ApiKeyCreateRequest
object
Request model for creating an API key.
4 properties 3 required
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
DeleteResponse
object
2 properties 2 required
ApiKeySharingGroupsUpdateRequest
object
Request model for updating API key sharing groups.
1 property 1 required
ApiKeyCreateResponse
object
Response model for API key creation. Includes the full API key (shown only once).
2 properties 2 required
ApiKeyListResponse
object
Response model for listing API keys.
1 property
ApiKeyResponse
object
Response model for API key (excludes sensitive data).
11 properties 5 required
ApiKeyScopeRole
string
Role that can be assigned to an API key for a scoped resource.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal-use-api-keys-api-openapi.yml Raw ↑

Other APIs Terminal Use publishes across the network.

Terminal Use Agent APIKeys API
Terminal Use Agent Task Tracker API
Terminal Use Agents API
Terminal Use Authentication API
Terminal Use Branch Events API
Terminal Use Branches API
Terminal Use Builds API
Terminal Use CLI Authentication API
Terminal Use Environments API
Terminal Use Events API
Terminal Use Filesystems API
Terminal Use Groups API