NimbusNexus V1:octavia:health Monitors API
The v1:octavia:health_monitors API from NimbusNexus — 2 operation(s) for v1:octavia:health_monitors.
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-health-monitors-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:health Monitors 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:health_monitors
paths:
/api/v1/health_monitors/:
post:
tags:
- v1:octavia:health_monitors
summary: Create Health Monitor
description: Creates a new health monitor for a pool.
operationId: create_health_monitor_api_v1_health_monitors__post
security:
- SwaggerLogin: []
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HealthMonitorCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveHealthMonitorOut'
'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'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'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'
get:
tags:
- v1:octavia:health_monitors
summary: List Health Monitor
description: Lists health monitors visible in the current scope, filtered by query parameters.
operationId: list_health_monitor_api_v1_health_monitors__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: delay
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Delay
- name: max_retries
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Max Retries
- name: pool_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Pool Id
- name: timeout
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Timeout
- name: type
in: query
required: false
schema:
anyOf:
- enum:
- HTTP
- HTTPS
- PING
- SCTP
- TCP
- TLS-HELLO
- UDP-CONNECT
type: string
- type: 'null'
title: Type
- name: admin_state_up
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
- name: expected_codes
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Expected Codes
- name: http_method
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Http Method
- name: max_retries_down
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Max Retries Down
- name: url_path
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Url Path
- name: provisioning_status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Provisioning Status
- name: operating_status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Operating Status
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListHealthMonitorOut'
'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'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'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'
/api/v1/health_monitors/{healthmonitor_id}:
get:
tags:
- v1:octavia:health_monitors
summary: Get Health Monitor
description: Retrieves the details of a single health monitor by ID.
operationId: get_health_monitor_api_v1_health_monitors__healthmonitor_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: healthmonitor_id
in: path
required: true
schema:
type: string
format: uuid
title: Healthmonitor Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveHealthMonitorOut'
'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'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'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'
patch:
tags:
- v1:octavia:health_monitors
summary: Update Health Monitor
description: Updates the mutable attributes of an existing health monitor.
operationId: update_health_monitor_api_v1_health_monitors__healthmonitor_id__patch
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: healthmonitor_id
in: path
required: true
schema:
type: string
format: uuid
title: Healthmonitor Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HealthMonitorUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveHealthMonitorOut'
'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'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'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'
delete:
tags:
- v1:octavia:health_monitors
summary: Delete Health Monitor
description: Deletes the specified health monitor.
operationId: delete_health_monitor_api_v1_health_monitors__healthmonitor_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: healthmonitor_id
in: path
required: true
schema:
type: string
format: uuid
title: Healthmonitor 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'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'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'
components:
schemas:
HealthMonitorUpdate:
properties:
delay:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Delay
max_retries:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Max Retries
pool_id:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Pool Id
timeout:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Timeout
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Health Monitor's name
expected_codes:
anyOf:
- type: string
- type: 'null'
title: Expected Codes
description: Health Monitor's expected codes
http_method:
anyOf:
- type: string
enum:
- OPTIONS
- GET
- PUT
- CONNECT
- POST
- TRACE
- DELETE
- HEAD
- PATCH
- type: 'null'
title: Http Method
description: Health Monitor's http_method, HTTP/HTTPS only
http_version:
anyOf:
- type: number
enum:
- 1.0
- 1.1
- type: 'null'
title: Http Version
description: Health Monitor's http_version
max_retries_down:
anyOf:
- type: integer
- type: 'null'
title: Max Retries Down
description: Health Monitor's max_retries_down, Octavia uses 3 when omitted
url_path:
anyOf:
- type: string
- type: 'null'
title: Url Path
description: Health Monitor's url_path, HTTP/HTTPS only
type: object
title: HealthMonitorUpdate
HealthMonitorCreate:
properties:
delay:
type: integer
minimum: 1.0
title: Delay
description: Health Monitor's delay
max_retries:
type: integer
minimum: 1.0
title: Max Retries
description: Health Monitor's max retries
pool_id:
type: string
minLength: 1
title: Pool Id
description: Pool's id
timeout:
type: integer
minimum: 1.0
title: Timeout
description: Health Monitor's timeout
type:
type: string
enum:
- HTTP
- HTTPS
- PING
- SCTP
- TCP
- TLS-HELLO
- UDP-CONNECT
minLength: 1
title: Type
description: Health Monitor's type
admin_state_up:
type: boolean
title: Admin State Up
description: Health Monitor's admin_state_up, default is True
default: true
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Health Monitor's name
expected_codes:
anyOf:
- type: string
- type: 'null'
title: Expected Codes
description: Health Monitor's expected codes, HTTP/HTTPS only
http_method:
anyOf:
- type: string
enum:
- OPTIONS
- GET
- PUT
- CONNECT
- POST
- TRACE
- DELETE
- HEAD
- PATCH
- type: 'null'
title: Http Method
description: Health Monitor's http_method, HTTP/HTTPS only
http_version:
anyOf:
- type: number
enum:
- 1.0
- 1.1
- type: 'null'
title: Http Version
description: Health Monitor's http_version, HTTP/HTTPS only
max_retries_down:
anyOf:
- type: integer
- type: 'null'
title: Max Retries Down
description: Health Monitor's max_retries_down, Octavia uses 3 when omitted
url_path:
anyOf:
- type: string
- type: 'null'
title: Url Path
description: Health Monitor's url_path, HTTP/HTTPS only
type: object
required:
- delay
- max_retries
- pool_id
- timeout
- type
title: HealthMonitorCreate
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
HealthMonitorResponse:
properties:
id:
type: string
title: Id
description: Health Monitor's id
delay:
anyOf:
- type: integer
- type: 'null'
title: Delay
max_retries:
anyOf:
- type: integer
- type: 'null'
title: Max Retries
pools:
anyOf:
- items:
additionalProperties:
type: string
type: object
type: array
- type: 'null'
title: Pools
description: List of pools using this monitor
timeout:
anyOf:
- type: integer
- type: 'null'
title: Timeout
type:
anyOf:
- type: string
enum:
- HTTP
- HTTPS
- PING
- SCTP
- TCP
- TLS-HELLO
- UDP-CONNECT
- type: 'null'
title: Type
admin_state_up:
anyOf:
- type: boolean
- type: 'null'
title: Admin State Up
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Health Monitor's name
expected_codes:
anyOf:
- type: string
- type: 'null'
title: Expected Codes
description: Health Monitor's expected codes
http_method:
anyOf:
- type: string
- type: 'null'
title: Http Method
description: Health Monitor's http_method
http_version:
anyOf:
- type: number
- type: 'null'
title: Http Version
description: Health Monitor's http_version
max_retries_down:
anyOf:
- type: integer
- type: 'null'
title: Max Retries Down
description: Health Monitor's max_retries_down
url_path:
anyOf:
- type: string
- type: 'null'
title: Url Path
description: Health Monitor's url_path
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
type: object
required:
- id
title: HealthMonitorResponse
ResponseValidationErrorOut:
properties:
success:
type: boolean
title: Success
default: false
errors:
additionalProperties:
items:
type: string
type: array
type: object
title: Errors
type: object
required:
- errors
title: ResponseValidationErrorOut
ListHealthMonitorOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/HealthMonitorResponse'
type: array
title: Data
type: object
required:
- data
title: ListHealthMonitorOut
RetrieveHealthMonitorOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/HealthMonitorResponse'
type: object
required:
- data
title: RetrieveHealthMonitorOut
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>')