NimbusNexus V1:octavia:listeners API
The v1:octavia:listeners API from NimbusNexus — 3 operation(s) for v1:octavia:listeners.
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-listeners-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:listeners 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:listeners
paths:
/api/v1/listeners/:
post:
tags:
- v1:octavia:listeners
summary: Create Listener
description: Creates a new listener attached to a load balancer.
operationId: create_listener_api_v1_listeners__post
security:
- SwaggerLogin: []
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListenerCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveListenerOut'
'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:listeners
summary: List Listeners
description: Lists listeners visible in the current scope, filtered by query parameters.
operationId: list_listeners_api_v1_listeners__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
maxLength: 255
- type: 'null'
title: Name
- name: protocol
in: query
required: false
schema:
anyOf:
- enum:
- HTTP
- HTTPS
- SCTP
- PROMETHEUS
- TCP
- TERMINATED_HTTPS
- UDP
type: string
minLength: 1
- type: 'null'
title: Protocol
- name: protocol_port
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 65535
minimum: 1
- type: 'null'
title: Protocol Port
- name: loadbalancer_id
in: query
required: false
schema:
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
- name: description
in: query
required: false
schema:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
- name: tags
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by tags
title: Tags
description: Filter by tags
- name: admin_state_up
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListListenerOut'
'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/listeners/{listener_id}:
get:
tags:
- v1:octavia:listeners
summary: Get Listener
description: Retrieves the details of a single listener by ID.
operationId: get_listener_api_v1_listeners__listener_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: listener_id
in: path
required: true
schema:
type: string
format: uuid
title: Listener Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveListenerOut'
'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:listeners
summary: Update Listener
description: Updates the mutable attributes of an existing listener.
operationId: update_listener_api_v1_listeners__listener_id__patch
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: listener_id
in: path
required: true
schema:
type: string
format: uuid
title: Listener Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListenerUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveListenerOut'
'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:listeners
summary: Delete Listener
description: Deletes the specified listener.
operationId: delete_listener_api_v1_listeners__listener_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: listener_id
in: path
required: true
schema:
type: string
format: uuid
title: Listener 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'
/api/v1/listeners/{listener_id}/stats:
get:
tags:
- v1:octavia:listeners
summary: Get Listener Stats
description: Returns traffic statistics for the specified listener.
operationId: get_listener_stats_api_v1_listeners__listener_id__stats_get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: listener_id
in: path
required: true
schema:
type: string
format: uuid
title: Listener Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListenerStatsOut'
'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'
components:
schemas:
ListListenerOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/ListenerOut'
type: array
title: Data
type: object
required:
- data
title: ListListenerOut
ListenerStatsOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/StatsModel'
type: object
required:
- data
title: ListenerStatsOut
ListenerCreate:
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
connection_limit:
anyOf:
- type: integer
minimum: -1.0
- type: 'null'
title: Connection Limit
default_pool_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Default Pool Id
default_tls_container_ref:
anyOf:
- type: string
- type: 'null'
title: Default Tls Container Ref
sni_container_refs:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Sni Container Refs
description:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: Filter by tags
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
loadbalancer_id:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
title: Loadbalancer Id
protocol_port:
type: integer
maximum: 65535.0
minimum: 1.0
title: Protocol Port
protocol:
type: string
enum:
- HTTP
- HTTPS
- SCTP
- PROMETHEUS
- TCP
- TERMINATED_HTTPS
- UDP
title: Protocol
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
type: object
required:
- loadbalancer_id
- protocol_port
- protocol
title: ListenerCreate
ListenerOut:
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
connection_limit:
anyOf:
- type: integer
minimum: -1.0
- type: 'null'
title: Connection Limit
default_pool_id:
anyOf:
- type: string
- type: 'null'
title: Default Pool Id
default_tls_container_ref:
anyOf:
- type: string
- type: 'null'
title: Default Tls Container Ref
sni_container_refs:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Sni Container Refs
description:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: Filter by tags
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
id:
anyOf:
- type: string
- type: 'null'
title: Id
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
protocol_port:
anyOf:
- type: integer
- type: 'null'
title: Protocol Port
protocol:
anyOf:
- type: string
- type: 'null'
title: Protocol
provisioning_status:
anyOf:
- type: string
- type: 'null'
title: Provisioning Status
operating_status:
anyOf:
- type: string
- type: 'null'
title: Operating Status
loadbalancers:
anyOf:
- items:
additionalProperties:
type: string
type: object
type: array
- type: 'null'
title: Loadbalancers
type: object
title: ListenerOut
ListenerUpdate:
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
connection_limit:
anyOf:
- type: integer
minimum: -1.0
- type: 'null'
title: Connection Limit
default_pool_id:
anyOf:
- type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
- type: 'null'
title: Default Pool Id
default_tls_container_ref:
anyOf:
- type: string
- type: 'null'
title: Default Tls Container Ref
sni_container_refs:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Sni Container Refs
description:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Description
tags:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tags
description: Filter by tags
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
additionalProperties: false
type: object
title: ListenerUpdate
RetrieveListenerOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/ListenerOut'
type: object
required:
- data
title: RetrieveListenerOut
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
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
StatsModel:
properties:
bytes_in:
type: integer
title: Bytes In
total_connections:
type: integer
title: Total Connections
active_connections:
type: integer
title: Active Connections
bytes_out:
type: integer
title: Bytes Out
request_errors:
type: integer
title: Request Errors
type: object
required:
- bytes_in
- total_connections
- active_connections
- bytes_out
- request_errors
title: StatsModel
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>')