Message Brokers

List Message Brokers

get

Retrieves a paginated list of message brokers.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

filter[description]stringOptional

Filter results by description.

filter[host]stringOptional

Filter results by host.

filter[protocol]stringOptional

Filter results by protocol.

filter[auth_type]stringOptional

Filter results by auth_type.

filter[port]stringOptional

Filter results by port.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBrokerQueues, variables, flowMessageBrokerQueues

sortstringOptional

Sort field. Prefix with - for descending. Available: name, description, host, port, protocol, auth_type

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers

HTTPcURLJavaScriptPython

GET /api/v1/message-brokers HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "description": "A description of the resource",
      "host": "example_host",
      "port": 1,
      "protocol": "HTTP",
      "auth_type": "example_auth_type",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/message-brokers",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/message-brokers?page=1",
    "last": "https://api.example.com/api/v1/message-brokers?page=1",
    "prev": null,
    "next": null
  }
}

Create Message Broker

post

Creates a new message broker.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

descriptionstring · max: 100Required

hoststringRequired

portintegerRequired

protocolstring · enumRequiredPossible values:

auth_typestringRequired

namestring · max: 40RequiredPattern: ^[a-zA-Z0-9 -]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/message-brokers

HTTPcURLJavaScriptPython

POST /api/v1/message-brokers HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "description": "text",
  "host": "text",
  "port": 1,
  "protocol": "HTTP",
  "auth_type": "text",
  "name": "text"
}

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Get Message Broker

get

Retrieves the details of a specific message broker.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

message_brokerstringRequired

The message broker identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[description]stringOptional

Filter results by description.

filter[host]stringOptional

Filter results by host.

filter[protocol]stringOptional

Filter results by protocol.

filter[auth_type]stringOptional

Filter results by auth_type.

filter[port]stringOptional

Filter results by port.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBrokerQueues, variables, flowMessageBrokerQueues

sortstringOptional

Sort field. Prefix with - for descending. Available: name, description, host, port, protocol, auth_type

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers/{message_broker}

HTTPcURLJavaScriptPython

GET /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update Message Broker

put

Updates an existing message broker.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

message_brokerstringRequired

The message broker identifier.

Body

application/json

descriptionstring · max: 100Optional

hoststringOptional

portintegerOptional

protocolstring · enumOptionalPossible values:

auth_typestringOptional

namestring · max: 40OptionalPattern: ^[a-zA-Z0-9 -]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/message-brokers/{message_broker}

HTTPcURLJavaScriptPython

PUT /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "description": "text",
  "host": "text",
  "port": 1,
  "protocol": "HTTP",
  "auth_type": "text",
  "variables": {
    "*": {
      "id": "text",
      "key": "text",
      "value": "text",
      "label": "text",
      "secret": true,
      "locked": true,
      "pivot": {
        "alias": "text",
        "configurable": true,
        "required": true,
        "advanced": true
      }
    }
  },
  "name": "text"
}

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Message Broker

delete

Permanently deletes a specific message broker.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

message_brokerstringRequired

The message broker identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/message-brokers/{message_broker}

HTTPcURLJavaScriptPython

DELETE /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}