NimbusNexus V1:octavia:members API
The v1:octavia:members API from NimbusNexus — 2 operation(s) for v1:octavia:members.
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-members-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:members 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:members
paths:
/api/v1/pools/{pool_id}/members/:
post:
tags:
- v1:octavia:members
summary: Create Member
description: Adds a new backend member to the specified pool.
operationId: create_member_api_v1_pools__pool_id__members__post
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/MemberCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveMemberOut'
'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'
'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:members
summary: List Members
description: Lists backend members of the specified pool, filtered by query parameters.
operationId: list_members_api_v1_pools__pool_id__members__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
- 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: address
in: query
required: false
schema:
anyOf:
- type: string
format: ipvanyaddress
- type: 'null'
title: Address
- name: weight
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 256
minimum: 0
- type: 'null'
title: Weight
- name: monitor_address
in: query
required: false
schema:
anyOf:
- type: string
format: ipvanyaddress
- type: 'null'
title: Monitor Address
- name: protocol_port
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 65535
minimum: 1
- type: 'null'
title: Protocol Port
- name: monitor_port
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 65535
minimum: 1
- type: 'null'
title: Monitor Port
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemberOut'
'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'
put:
tags:
- v1:octavia:members
summary: Batch Update Members
description: Replaces or additively updates the full set of members for a pool in one batch.
operationId: batch_update_members_api_v1_pools__pool_id__members__put
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/MemberBatchUpdate'
responses:
'202':
description: Successful Response
content:
application/json:
schema: {}
'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'
/api/v1/pools/{pool_id}/members/{member_id}:
get:
tags:
- v1:octavia:members
summary: Get Member
description: Retrieves a single backend member of a pool by ID.
operationId: get_member_api_v1_pools__pool_id__members__member_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
- name: member_id
in: path
required: true
schema:
type: string
format: uuid
title: Member Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveMemberOut'
'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:members
summary: Update Member
description: Updates the mutable attributes of an existing pool member.
operationId: update_member_api_v1_pools__pool_id__members__member_id__patch
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
- name: member_id
in: path
required: true
schema:
type: string
format: uuid
title: Member Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MemberUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveMemberOut'
'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:members
summary: Delete Member
description: Removes a backend member from the specified pool.
operationId: delete_member_api_v1_pools__pool_id__members__member_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
title: Pool Id
- name: member_id
in: path
required: true
schema:
type: string
format: uuid
title: Member Id
responses:
'204':
description: Successful Response
'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:
MemberSingleBatchUpdate:
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
address:
type: string
format: ipvanyaddress
title: Address
protocol_port:
type: integer
maximum: 65535.0
minimum: 1.0
title: Protocol Port
weight:
anyOf:
- type: integer
maximum: 256.0
minimum: 0.0
- type: 'null'
title: Weight
default: 1
monitor_address:
anyOf:
- type: string
format: ipvanyaddress
- type: 'null'
title: Monitor Address
monitor_port:
anyOf:
- type: integer
maximum: 65535.0
minimum: 1.0
- type: 'null'
title: Monitor Port
admin_state_up:
type: boolean
title: Admin State Up
default: true
subnet_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Subnet Id
description: The subnet ID where the member IP is located. Required for OVN
type: object
required:
- address
- protocol_port
title: MemberSingleBatchUpdate
RetrieveMemberOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/MemberResponse'
type: object
required:
- data
title: RetrieveMemberOut
MemberResponse:
properties:
id:
type: string
title: Id
description: Member's id
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Member's name
weight:
anyOf:
- type: integer
- type: 'null'
title: Weight
description: Member's weight
backup:
anyOf:
- type: boolean
- type: 'null'
title: Backup
description: Member's backup
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
description: Member's admin_state_up
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: Project's id
monitor_port:
anyOf:
- type: integer
- type: 'null'
title: Monitor Port
description: Monitor's port
monitor_address:
anyOf:
- type: string
- type: 'null'
title: Monitor Address
description: Monitor's address
subnet_id:
anyOf:
- type: string
- type: 'null'
title: Subnet Id
description: Subnet id
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Member's created_at
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Member's updated_at
provisioning_status:
anyOf:
- type: string
- type: 'null'
title: Provisioning Status
description: Member's provisioning_status
operating_status:
anyOf:
- type: string
- type: 'null'
title: Operating Status
description: Member's operating_status
address:
anyOf:
- type: string
- type: 'null'
title: Address
description: Member's address
protocol_port:
anyOf:
- type: integer
- type: 'null'
title: Protocol Port
description: Member's protocol_port
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: Member's tags
type: object
required:
- id
title: MemberResponse
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
MemberUpdate:
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
weight:
anyOf:
- type: integer
maximum: 256.0
minimum: 0.0
- type: 'null'
title: Weight
monitor_address:
anyOf:
- type: string
format: ipvanyaddress
- type: 'null'
title: Monitor Address
monitor_port:
anyOf:
- type: integer
maximum: 65535.0
minimum: 1.0
- type: 'null'
title: Monitor Port
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
type: object
title: MemberUpdate
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
MemberBatchUpdate:
properties:
admin_domain:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
admin_project:
anyOf:
- type: string
- type: 'null'
title: Admin Project
additive_only:
type: boolean
title: Additive Only
default: false
members:
items:
$ref: '#/components/schemas/MemberSingleBatchUpdate'
type: array
title: Members
type: object
required:
- members
title: MemberBatchUpdate
ListMemberOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/MemberResponse'
type: array
title: Data
type: object
required:
- data
title: ListMemberOut
MemberCreate:
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
address:
type: string
format: ipvanyaddress
title: Address
protocol_port:
type: integer
maximum: 65535.0
minimum: 1.0
title: Protocol Port
weight:
anyOf:
- type: integer
maximum: 256.0
minimum: 0.0
- type: 'null'
title: Weight
default: 1
monitor_address:
anyOf:
- type: string
format: ipvanyaddress
- type: 'null'
title: Monitor Address
monitor_port:
anyOf:
- type: integer
maximum: 65535.0
minimum: 1.0
- type: 'null'
title: Monitor Port
admin_state_up:
type: boolean
title: Admin State Up
default: true
subnet_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Subnet Id
description: The subnet ID where the member IP is located. Required for OVN
type: object
required:
- address
- protocol_port
title: MemberCreate
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>')