OpenStack Endpoints API

Service endpoint URLs per region and interface.

OpenAPI Specification

openstack-endpoints-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: OpenStack Identity (Keystone) API v3 Domains Endpoints API
  description: Keystone is the OpenStack Identity service that provides authentication, authorization, and a service catalog for an OpenStack cloud. Tokens issued by Keystone are required to call any other OpenStack service API. The v3 API exposes endpoints for tokens, users, groups, projects, domains, roles, role assignments, services, endpoints, and the service catalog.
  version: '3'
  contact:
    name: OpenStack Identity (Keystone)
    url: https://docs.openstack.org/keystone/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{keystone-host}:5000/v3
  description: Keystone Identity API v3 endpoint (deployment specific)
  variables:
    keystone-host:
      default: keystone.example.com
security:
- TokenAuth: []
tags:
- name: Endpoints
  description: Service endpoint URLs per region and interface.
paths:
  /endpoints:
    get:
      operationId: listEndpoints
      summary: List service endpoints
      tags:
      - Endpoints
      responses:
        '200':
          description: List of endpoints.
    post:
      operationId: createEndpoint
      summary: Create endpoint
      tags:
      - Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Endpoint created.
components:
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
externalDocs:
  description: Keystone v3 API reference
  url: https://docs.openstack.org/api-ref/identity/v3/