NimbusNexus V1:keystone:api Keys API

The v1:keystone:api_keys API from NimbusNexus — 6 operation(s) for v1:keystone:api_keys.

Operations 8

GET /api/v1/api_keys/access_rules_artifacts Access Rules Artifacts #
POST /api/v1/api_keys/ Create Api Key #
GET /api/v1/api_keys/list List Api Keys #
DELETE /api/v1/api_keys/{api_key_id} Delete Api Key #
GET /api/v1/api_keys/{api_key_id} Get Api Key #
GET /api/v1/api_keys/access_rules/list List Access Rules #
GET /api/v1/api_keys/access_rules/{access_rule_id} Get Access Rule #
DELETE /api/v1/api_keys/access_rules/{access_rule_id} Delete Access Rule #

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/nimbusnexus:nimbusnexus-v1-keystone-api-keys-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.

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

OpenAPI Specification

nimbusnexus-v1-keystone-api-keys-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NimbusNexus API — External V1:keystone:api Keys API
  description: 'External (public) API intended for client-facing integrations and the web portal.


    Authentication:

    - This API uses JWT Bearer authentication.

    - In Swagger UI, click ''Authorize'' and sign in via the configured token endpoint.

    - Swagger will automatically attach the header: Authorization: Bearer .'
  version: test
servers:
- url: /
  description: Current host
- url: https://fastapi.dev.nimbusnexus.net
  description: Development
security:
- SwaggerLogin: []
- ApiKeyAuth: []
tags:
- name: v1:keystone:api_keys
paths:
  /api/v1/api_keys/access_rules_artifacts:
    get:
      tags:
      - v1:keystone:api_keys
      summary: Access Rules Artifacts
      description: Returns a complete list of methods and paths registered in FastAPI.
      operationId: access_rules_artifacts_api_v1_api_keys_access_rules_artifacts_get
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: params
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Params
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/api_keys/:
    post:
      tags:
      - v1:keystone:api_keys
      summary: Create Api Key
      description: Create an application credential (API key). The secret is returned only once.
      operationId: create_api_key_api_v1_api_keys__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyCreateIn'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreateOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Conflict
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
  /api/v1/api_keys/list:
    get:
      tags:
      - v1:keystone:api_keys
      summary: List Api Keys
      description: List application credentials (API keys) belonging to the current user. Secrets are never returned.
      operationId: list_api_keys_api_v1_api_keys_list_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyListOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
  /api/v1/api_keys/{api_key_id}:
    delete:
      tags:
      - v1:keystone:api_keys
      summary: Delete Api Key
      description: Delete (revoke) an application credential (API key).
      operationId: delete_api_key_api_v1_api_keys__api_key_id__delete
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                success: false
                message: Bad Request
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                success: false
                message: Forbidden
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                success: false
                message: Not Found
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                success: false
                errors:
                  field:
                  - Invalid value
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                success: false
                message: Internal Server Error
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
    get:
      tags:
      - v1:keystone:api_keys
      summary: Get Api Key
      description: Get a single application credential (API key) by id.
      operationId: get_api_key_api_v1_api_keys__api_key_id__get
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDetailOut'
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                success: false
                message: Bad Request
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                success: false
                message: Forbidden
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                success: false
                message: Not Found
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                success: false
                message: Internal Server Error
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/api_keys/access_rules/list:
    get:
      tags:
      - v1:keystone:api_keys
      summary: List Access Rules
      description: List the access rules associated with a user's application credentials.
      operationId: list_access_rules_api_v1_api_keys_access_rules_list_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRuleListOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Not Found
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
  /api/v1/api_keys/access_rules/{access_rule_id}:
    get:
      tags:
      - v1:keystone:api_keys
      summary: Get Access Rule
      description: Show the details of a single access rule by id.
      operationId: get_access_rule_api_v1_api_keys_access_rules__access_rule_id__get
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: access_rule_id
        in: path
        required: true
        schema:
          type: string
          title: Access Rule Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRuleDetailOut'
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                success: false
                message: Bad Request
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                success: false
                message: Forbidden
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                success: false
                message: Not Found
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                success: false
                message: Internal Server Error
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - v1:keystone:api_keys
      summary: Delete Access Rule
      description: Delete an access rule by id.
      operationId: delete_access_rule_api_v1_api_keys_access_rules__access_rule_id__delete
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: access_rule_id
        in: path
        required: true
        schema:
          type: string
          title: Access Rule Id
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                success: false
                message: Bad Request
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                success: false
                message: Forbidden
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                success: false
                message: Not Found
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                success: false
                errors:
                  field:
                  - Invalid value
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                success: false
                message: Internal Server Error
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
components:
  schemas:
    ApiKeyAccessRuleOut:
      properties:
        method:
          type: string
          title: Method
          default: ''
        path:
          type: string
          title: Path
          default: ''
        service:
          type: string
          title: Service
          default: ''
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
      type: object
      title: ApiKeyAccessRuleOut
    ApiKeyRoleOut:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
      type: object
      title: ApiKeyRoleOut
    AccessRuleListOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          items:
            $ref: '#/components/schemas/ApiKeyAccessRuleOut'
          type: array
          title: Data
      type: object
      title: AccessRuleListOut
    ApiKeyCreatedOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
        unrestricted:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Unrestricted
        roles:
          items:
            $ref: '#/components/schemas/ApiKeyRoleOut'
          type: array
          title: Roles
        access_rules:
          items:
            $ref: '#/components/schemas/ApiKeyAccessRuleOut'
          type: array
          title: Access Rules
          default: []
        secret:
          type: string
          minLength: 1
          title: Secret
          description: Secret is returned only once at creation time
        api_key:
          type: string
          minLength: 3
          title: Api Key
          description: 'Convenience field: ''<id>:<secret>'' in base64 format'
      type: object
      required:
      - id
      - name
      - secret
      - api_key
      title: ApiKeyCreatedOut
    ApiKeyListOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          items:
            $ref: '#/components/schemas/ApiKeyOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: ApiKeyListOut
    ApiKeyDetailOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          $ref: '#/components/schemas/ApiKeyOut'
      type: object
      required:
      - data
      title: ApiKeyDetailOut
    ApiKeyAccessRuleIn:
      properties:
        method:
          $ref: '#/components/schemas/Method'
        path:
          type: string
          maxLength: 1024
          minLength: 1
          pattern: ^/[A-Za-z0-9_\-./{}:*]*$
          title: Path
          description: API path, e.g. /v2.1/servers
        service:
          allOf:
          - $ref: '#/components/schemas/Service'
          description: OpenStack service type, e.g. compute
          default: api
      type: object
      required:
      - method
      - path
      title: ApiKeyAccessRuleIn
    Service:
      type: string
      enum:
      - block-storage
      - volumev3
      - compute
      - identity
      - network
      - image
      - load-balancer
      - dns
      - object-store
      - api
      title: Service
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ResponseBaseErrorOut:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ResponseBaseErrorOut
    ApiKeyCreateOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
          - $ref: '#/components/schemas/ApiKeyCreatedOut'
          - $ref: '#/components/schemas/ApiKeyOut'
          title: Data
      type: object
      required:
      - data
      title: ApiKeyCreateOut
    ApiKeyOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
        unrestricted:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Unrestricted
        roles:
          items:
            $ref: '#/components/schemas/ApiKeyRoleOut'
          type: array
          title: Roles
        access_rules:
          items:
            $ref: '#/components/schemas/ApiKeyAccessRuleOut'
          type: array
          title: Access Rules
          default: []
      type: object
      required:
      - id
      - name
      title: ApiKeyOut
    AccessRuleDetailOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          $ref: '#/components/schemas/ApiKeyAccessRuleOut'
      type: object
      required:
      - data
      title: AccessRuleDetailOut
    ResponseValidationErrorOut:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Errors
      type: object
      required:
      - errors
      title: ResponseValidationErrorOut
    Method:
      type: string
      enum:
      - GET
      - POST
      - PUT
      - DELETE
      - PATCH
      - HEAD
      - OPTIONS
      title: Method
    ApiKeyCreateIn:
      properties:
        name:
          type: string
          maxLength: 64
          minLength: 1
          title: Name
        secret:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Secret
          description: If omitted, Keystone generates it
        description:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Description
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
          description: ISO8601 datetime
        roles:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Roles
          description: Role names or IDs. If omitted, Keystone uses defaults (usually user's roles in the project).
        unrestricted:
          type: boolean
          title: Unrestricted
          description: Potentially dangerous. Default is restricted behavior.
          default: false
        access_rules:
          anyOf:
          - items:
              $ref: '#/components/schemas/ApiKeyAccessRuleIn'
            type: array
          - type: 'null'
          title: Access Rules
          example:
          - route: GET /api/v1/image
      type: object
      required:
      - name
      title: ApiKeyCreateIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    SwaggerLogin:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/v1/account/login_swagger
          scopes: {}
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key format -  base64('<id>:<secret>')