NimbusNexus V1:octavia:pools API
The v1:octavia:pools API from NimbusNexus — 2 operation(s) for v1:octavia:pools.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nimbusnexus:nimbusnexus-v1-octavia-pools-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
openapi: 3.2.0
info:
title: NimbusNexus API — External V1:octavia:pools 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:octavia:pools
paths:
/api/v1/pools/:
post:
tags:
- v1:octavia:pools
summary: Create Pool
description: Creates a new backend pool on a load balancer.
operationId: create_pool_api_v1_pools__post
security:
- SwaggerLogin: []
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePool'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievePoolOut'
'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'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
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'
get:
tags:
- v1:octavia:pools
summary: List Pools
description: Lists backend pools visible in the current scope, filtered by query parameters.
operationId: list_pools_api_v1_pools__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: admin_domain
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
- name: admin_project
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Project
- name: project
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Project
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: description
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Description
- name: protocol
in: query
required: false
schema:
anyOf:
- enum:
- HTTP
- HTTPS
- TCP
- UDP
- PROXY
- PROXYV2
- SCTP
type: string
- type: 'null'
title: Protocol
- name: loadbalancer_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Loadbalancer Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListPoolOut'
'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'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
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/pools/{pool_id}:
get:
tags:
- v1:octavia:pools
summary: Get Pool
description: Retrieves the details of a single backend pool by ID.
operationId: get_pool_api_v1_pools__pool_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievePoolOut'
'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'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
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'
patch:
tags:
- v1:octavia:pools
summary: Update Pool
description: Updates the mutable attributes of an existing backend pool.
operationId: update_pool_api_v1_pools__pool_id__patch
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePool'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievePoolOut'
'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'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
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:octavia:pools
summary: Delete Pool
description: Deletes the specified backend pool.
operationId: delete_pool_api_v1_pools__pool_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool 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'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
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'
components:
schemas:
ListPoolOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/PoolResponse'
type: array
title: Data
type: object
required:
- data
title: ListPoolOut
PoolResponse:
properties:
id:
type: string
title: Id
description: Pool's id
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Pool's name
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Pool's description
protocol:
type: string
title: Protocol
description: Pool's protocol
lb_algorithm:
type: string
title: Lb Algorithm
description: Pool's lb_algorithm
listeners:
anyOf:
- items:
additionalProperties:
type: string
type: object
type: array
- type: 'null'
title: Listeners
description: Pool's listeners
loadbalancers:
anyOf:
- items:
additionalProperties:
type: string
type: object
type: array
- type: 'null'
title: Loadbalancers
description: Pool's loadbalancers
healthmonitor_id:
anyOf:
- type: string
- type: 'null'
title: Healthmonitor Id
description: ID of the health monitor attached to the pool
admin_state_up:
type: boolean
title: Admin State Up
description: Pool's admin_state_up
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: Pool's project_id
provisioning_status:
anyOf:
- type: string
- type: 'null'
title: Provisioning Status
description: Pool's provisioning_status
operating_status:
anyOf:
- type: string
- type: 'null'
title: Operating Status
description: Pool's operating_status
type: object
required:
- id
- protocol
- lb_algorithm
- admin_state_up
title: PoolResponse
RetrievePoolOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/PoolResponse'
type: object
required:
- data
title: RetrievePoolOut
CreatePool:
properties:
admin_domain:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
admin_project:
anyOf:
- type: string
- type: 'null'
title: Admin Project
name:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Name
description: Pool's name
description:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
description: Pool's description
protocol:
type: string
enum:
- HTTP
- HTTPS
- TCP
- UDP
- PROXY
- PROXYV2
- SCTP
title: Protocol
lb_algorithm:
type: string
enum:
- ROUND_ROBIN
- LEAST_CONNECTIONS
- SOURCE_IP
- SOURCE_IP_PORT
title: Lb Algorithm
loadbalancer_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Loadbalancer Id
listener_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Listener Id
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
default: true
type: object
required:
- protocol
- lb_algorithm
title: CreatePool
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
UpdatePool:
properties:
admin_domain:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
admin_project:
anyOf:
- type: string
- type: 'null'
title: Admin Project
name:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Name
description: Pool's name
description:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
description: New pool's description
lb_algorithm:
anyOf:
- type: string
enum:
- ROUND_ROBIN
- LEAST_CONNECTIONS
- SOURCE_IP
- type: 'null'
title: Lb Algorithm
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
type: object
title: UpdatePool
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>')