Akuity

Akuity Api Key Service API

The Api Key Service API from Akuity — 4 operation(s) for api key service.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /api/v1/apikeys/{id} Delete an API key · Delete APIKey #
Ask an LLM
“How do I revoke an API key that leaked?”
“Can I permanently remove an organization-level API key?”
Tell an agent destructive · confirm first
Delete API key {id}.
Revoke organization key {id} for good.
GET /api/v1/apikeys/{id} Get an API key's details · Get APIKey #
Ask an LLM
“What permissions and expiry does one of my Akuity API keys have?”
“Can I look up an organization API key by its ID?”
Tell an agent
Show API key {id}.
Look up the details of organization key {id}.
POST /api/v1/apikeys/{id}/regenerate Regenerate an API key's secret · Regenerate APIKey Secret #
Ask an LLM
“How do I rotate the secret of an existing API key without creating a new key?”
“Can I set a new expiry when regenerating a key's secret?”
Tell an agent
Regenerate the secret for API key {id}.
Rotate key {id}'s secret and make it expire at {expiry}.
DELETE /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id} Delete a workspace API key · Delete Workspace APIKey #
Ask an LLM
“How do I revoke an API key issued for a single workspace?”
“Is deleting a workspace key immediate and permanent?”
Tell an agent destructive · confirm first
Delete workspace API key {id} from workspace {workspace_id} in org {organization_id}.
Revoke the workspace {workspace_id} key {id} under organization {organization_id}.
GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id} Get a workspace API key's details · Get Workspace APIKey #
Ask an LLM
“What does a workspace-scoped API key grant?”
“Where do I look up a key that belongs to one workspace?”
Tell an agent
Show workspace API key {id} in workspace {workspace_id} of org {organization_id}.
Inspect the key {id} scoped to workspace {workspace_id}, organization {organization_id}.
POST /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}/regenerate Regenerate a workspace API key's secret · Regenerate Workspace APIKey Secret #
Ask an LLM
“How do I rotate the secret on a workspace-scoped API key?”
“Can a workspace key get a fresh secret with a new expiration date?”
Tell an agent
Regenerate the secret of workspace key {id} in workspace {workspace_id}, org {organization_id}.
Rotate workspace {workspace_id} key {id} in {organization_id} with expiry {expiry}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/openapi/akuity-api-key-service-api-openapi.yml

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-organization.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-argocd.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-kargo.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-system.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-apikey.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-customrole.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-auth.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-extension.proto

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/akuity:akuity-api-key-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

akuity-api-key-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: info@akuity.io
    name: Akuity
    url: https://docs.akuity.io/akuity-portal/automation/api
  description: The API Keys surface of the Akuity Platform REST API (grpc-gateway projection of apikey/v1). Derived mechanically from the protobuf service descriptors and google.api.http annotations published in the akuity/api-client-go Go module.
  title: Akuity Platform API — API Keys API Key Service API
  version: v1
servers:
- description: Akuity Platform (SaaS)
  url: https://akuity.cloud
security:
- basicAuth: []
tags:
- name: Api Key Service
paths:
  /api/v1/apikeys/{id}:
    delete:
      operationId: APIKeyService_DeleteAPIKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_DeleteAPIKeyResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Delete APIKey
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/DeleteAPIKey
    get:
      operationId: APIKeyService_GetAPIKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_GetAPIKeyResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get APIKey
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/GetAPIKey
  /api/v1/apikeys/{id}/regenerate:
    post:
      operationId: APIKeyService_RegenerateAPIKeySecret
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_apikey_v1_RegenerateAPIKeySecretRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_RegenerateAPIKeySecretResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Regenerate APIKey Secret
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/RegenerateAPIKeySecret
  /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}:
    delete:
      operationId: APIKeyService_DeleteWorkspaceAPIKey
      parameters:
      - in: path
        name: organization_id
        required: true
        schema:
          type: string
      - in: path
        name: workspace_id
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_DeleteWorkspaceAPIKeyResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Delete Workspace APIKey
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/DeleteWorkspaceAPIKey
    get:
      operationId: APIKeyService_GetWorkspaceAPIKey
      parameters:
      - in: path
        name: organization_id
        required: true
        schema:
          type: string
      - in: path
        name: workspace_id
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_GetWorkspaceAPIKeyResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Workspace APIKey
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/GetWorkspaceAPIKey
  /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/apikeys/{id}/regenerate:
    post:
      operationId: APIKeyService_RegenerateWorkspaceAPIKeySecret
      parameters:
      - in: path
        name: organization_id
        required: true
        schema:
          type: string
      - in: path
        name: workspace_id
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_apikey_v1_RegenerateWorkspaceAPIKeySecretRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_apikey_v1_RegenerateWorkspaceAPIKeySecretResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Regenerate Workspace APIKey Secret
      tags:
      - Api Key Service
      x-grpc-method: akuity.apikey.v1.APIKeyService/RegenerateWorkspaceAPIKeySecret
components:
  schemas:
    akuity_apikey_v1_GetWorkspaceAPIKeyResponse:
      properties:
        apiKey:
          $ref: '#/components/schemas/akuity_apikey_v1_APIKey'
      title: akuity.apikey.v1.GetWorkspaceAPIKeyResponse
      type: object
    akuity_apikey_v1_RegenerateAPIKeySecretRequest:
      properties:
        expiry:
          type: string
        id:
          type: string
      title: akuity.apikey.v1.RegenerateAPIKeySecretRequest
      type: object
    akuity_accesscontrol_v1_Permissions:
      properties:
        actions:
          items:
            type: string
          type: array
        customRoles:
          items:
            type: string
          type: array
        roles:
          items:
            type: string
          type: array
      title: akuity.accesscontrol.v1.Permissions
      type: object
    akuity_apikey_v1_RegenerateWorkspaceAPIKeySecretResponse:
      properties:
        apiKey:
          $ref: '#/components/schemas/akuity_apikey_v1_APIKey'
      title: akuity.apikey.v1.RegenerateWorkspaceAPIKeySecretResponse
      type: object
    akuity_apikey_v1_DeleteWorkspaceAPIKeyResponse:
      title: akuity.apikey.v1.DeleteWorkspaceAPIKeyResponse
      type: object
    akuity_apikey_v1_GetAPIKeyResponse:
      properties:
        apiKey:
          $ref: '#/components/schemas/akuity_apikey_v1_APIKey'
      title: akuity.apikey.v1.GetAPIKeyResponse
      type: object
    akuity_apikey_v1_APIKey:
      properties:
        createTime:
          format: date-time
          type: string
        description:
          type: string
        expireTime:
          format: date-time
          type: string
        id:
          type: string
        organizationId:
          type: string
        permissions:
          $ref: '#/components/schemas/akuity_accesscontrol_v1_Permissions'
        secret:
          type: string
      title: akuity.apikey.v1.APIKey
      type: object
    akuity_apikey_v1_DeleteAPIKeyResponse:
      title: akuity.apikey.v1.DeleteAPIKeyResponse
      type: object
    Status:
      properties:
        code:
          description: gRPC status code (google.rpc.Code)
          format: int32
          type: integer
        details:
          items:
            additionalProperties: true
            type: object
          type: array
        message:
          type: string
      title: google.rpc.Status
      type: object
    akuity_apikey_v1_RegenerateWorkspaceAPIKeySecretRequest:
      properties:
        expiry:
          type: string
        id:
          type: string
        organizationId:
          type: string
        workspaceId:
          type: string
      title: akuity.apikey.v1.RegenerateWorkspaceAPIKeySecretRequest
      type: object
    akuity_apikey_v1_RegenerateAPIKeySecretResponse:
      properties:
        apiKey:
          $ref: '#/components/schemas/akuity_apikey_v1_APIKey'
      title: akuity.apikey.v1.RegenerateAPIKeySecretResponse
      type: object
  securitySchemes:
    basicAuth:
      description: 'HTTP Basic auth: username = AKUITY_API_KEY_ID, password = AKUITY_API_KEY_SECRET.'
      scheme: basic
      type: http