Broker

Create Broker

post

Authorizations

Body

namestringRequired

connectionsinteger[]OptionalDefault: []

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/broker HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "connections": [
    1
  ]
}

{
  "key_id": "text",
  "secret_key": "text"
}

Delete Broker

delete

Authorizations

Query parameters

broker_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/broker?broker_id=1 HTTP/1.1
Host: 
Accept: */*

No content

Regenerate Secrets

post

Authorizations

Query parameters

broker_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/broker/secrets?broker_id=1 HTTP/1.1
Host: 
Accept: */*

{
  "key_id": "text",
  "secret_key": "text"
}

List Broker Connections

get

Authorizations

Responses

200

Successful Response

application/json

404

Not found

get

HTTPcURLJavaScriptPython

GET /api/broker/connections HTTP/1.1
Host: 
Accept: */*

[
  {
    "connection_name": "text",
    "connection_id": 1,
    "connection_type": "text",
    "group": "text"
  }
]

Set Broker Connections

post

Authorizations

Body

broker_idintegerRequired

connectionsinteger[]Required

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/broker/connections HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "broker_id": 1,
  "connections": [
    1
  ]
}

No content

List Brokers

get

Authorizations

Responses

200

Successful Response

application/json

404

Not found

get

HTTPcURLJavaScriptPython

GET /api/broker/brokers HTTP/1.1
Host: 
Accept: */*

[
  {
    "broker_name": "text",
    "broker_id": 1,
    "broker_status": "text",
    "broker_key_id": "text",
    "broker_status_details": [
      {
        "status": "text",
        "instance_id": "text",
        "cpu_utilization": 1,
        "memory_utilization": 1,
        "disk_utilization": 1,
        "current_jobs": [
          "text"
        ]
      }
    ],
    "broker_connections": [
      {
        "connection_name": "text",
        "connection_id": 1,
        "connection_type": "text",
        "connection_details": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  }
]