OpenStack Projects API

Project (tenant) management.

OpenAPI Specification

openstack-projects-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: OpenStack Identity (Keystone) API v3 Domains Projects 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: Projects
  description: Project (tenant) management.
paths:
  /projects:
    get:
      operationId: listProjects
      summary: List projects
      tags:
      - Projects
      responses:
        '200':
          description: List of projects.
    post:
      operationId: createProject
      summary: Create project
      tags:
      - Projects
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Project created.
  /projects/{project_id}:
    parameters:
    - name: project_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getProject
      summary: Get project
      tags:
      - Projects
      responses:
        '200':
          description: Project detail.
    patch:
      operationId: updateProject
      summary: Update project
      tags:
      - Projects
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Project updated.
    delete:
      operationId: deleteProject
      summary: Delete project
      tags:
      - Projects
      responses:
        '204':
          description: Project deleted.
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/