API docs by RedoclyContent Hub (1.0.1)
GET_v1-filters
List cloud filters tied to the account. Or get cloud filter by its name
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| name | string If name exists in query, the endpoint will act as get filter by name. Space should be replaced with %20 |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}POST_v1-filters
Add or modify a cloud filter on your account. If uuid is included in the body, Content Hub attempts to update a filter with the same UUID, or creates it if it doesn't exist. If the uuid is omitted, a new filter is always created.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects | |
| request_id | string <uuid> |
| success | boolean |
Responses
Request samples
- Payload
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true,
- "uuid": "defdef-a444-4000-a000-454545545454"
}PUT_v1-filters
Add or modify a cloud filter on your account. If uuid is included in the body, Content Hub attempts to update a filter with the same UUID, or creates it if it doesn't exist. If the uuid is omitted, a new filter is always created.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects | |
| request_id | string <uuid> |
| success | boolean |
Responses
Request samples
- Payload
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true,
- "uuid": "defdef-a444-4000-a000-454545545454"
}DELETE_v1-filters-uuid
Delete a single cloud filter from your account.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-filters-uuid
Retrieve data about a single cloud filter tied to your account.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}GET_v1-filters-uuid-execute
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}GET_v1-filters-uuid-subscriptions
List filter subscription webhooks for a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "filterID": "01230123-0123-0123-0123-012301230123",
}
], - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v1-filters-uuid-subscriptions
Subscribe to a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| url | string <url> |
Responses
Request samples
- Payload
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v1-filters-uuid-subscriptions
Update a filter subscription.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| url | string <url> |
Responses
Request samples
- Payload
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}Unsubscribe to a filter.
Unsubscribe to a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
| subscriptionID required | string subscription id, namely accountID |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}Retrieve data about a specific filter subscription
Retrieve data about a specific filter subscription for a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
| subscriptionID required | string subscription id, namely accountID |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}GET_v2-filters
List cloud filters tied to the account. Or get cloud filter by its name
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| name | string If name exists in query, the endpoint will act as get filter by name. Space should be replaced with %20 |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}POST_v2-filters
Add or modify a cloud filter on your account. If uuid is included in the body, Content Hub attempts to update a filter with the same UUID, or creates it if it doesn't exist. If the uuid is omitted, a new filter is always created.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects | |
| request_id | string <uuid> |
| success | boolean |
Responses
Request samples
- Payload
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true,
- "uuid": "defdef-a444-4000-a000-454545545454"
}PUT_v2-filters
Add or modify a cloud filter on your account. If uuid is included in the body, Content Hub attempts to update a filter with the same UUID, or creates it if it doesn't exist. If the uuid is omitted, a new filter is always created.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects | |
| request_id | string <uuid> |
| success | boolean |
Responses
Request samples
- Payload
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true,
- "uuid": "defdef-a444-4000-a000-454545545454"
}DELETE_v2-filters-uuid
Delete a single cloud filter from your account.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-filters-uuid
Retrieve data about a single cloud filter tied to your account.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "data": {
- "query": {
- "match_all": { }
}
}, - "metadata": {
- "display_name": "Match All"
}, - "uuid": "defdef-a444-4000-a000-454545545454"
}
], - "request_id": "abcdefed-0000-4000-a000-abcdefabcdef",
- "success": true
}GET_v2-filters-uuid-execute
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}POST_v2-filters-uuid-scroll
Create a scroll handle from a saved filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| scroll | string the scroll window expiry time, the time unit is minute, default value is 30 which means the scroll window will last 30 minutes |
| uuid required | string the filter's uuid |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_source": {
- "data": {
- "attributes": {
- "title": {
- "type": "string",
- "value": "Article title"
}
}, - "uuid": "00000000-0000-4000-8000-000000000000"
}, - "origin": "00000000-0000-4000-6000-000000000000",
- "type": "article",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}GET_v2-filters-uuid-subscriptions
List filter subscription webhooks for a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "filterID": "01230123-0123-0123-0123-012301230123",
}
], - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v2-filters-uuid-subscriptions
Subscribe to a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| url | string <url> |
Responses
Request samples
- Payload
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v2-filters-uuid-subscriptions
Update a filter subscription.
Authorizations:
path Parameters
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| url | string <url> |
Responses
Request samples
- Payload
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}Unsubscribe to a filter.
Unsubscribe to a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
| subscriptionID required | string subscription id, namely accountID |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}Retrieve data about a specific filter subscription
Retrieve data about a specific filter subscription for a filter.
Authorizations:
path Parameters
| filterID required | string filter uuid |
| subscriptionID required | string subscription id, namely accountID |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}check entity version of the current account ID (de
check entity version of the current account ID (detected through access key)
Authorizations:
Responses
Response samples
- 200
- 401
- 500
{- "request_id": "00000000-0000-4000-8000-000000000000",
- "success": true,
- "data": {
- "versions": "1"
}
}Perform a large amount of operations on entities a
Perform a large amount of operations on entities at once.
Authorizations:
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects |
Responses
Request samples
- Payload
{- "actions": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "type": "delete"
}, - {
- "id": "00000000-0000-0000-0000-000000000000",
- "type": "update"
},
]
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-entities
List all entities pertaining to the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| fields | string The name of attributes to return, as a comma-separated list. |
| filter:{name} | string Any amount of attribute filters. The name is the name of the attribute to filter by, and the value is a wildcard string to compare against. |
| language | string If set, reduces the returned attributes by returning the only the value for the provided language, instead |
| limit | number Sets the amount of entries to return. Defaults to 1000. Maximum 3000 entries can be retrieved by a single request. |
| origin | string Filter the list results by the origin field of the entities. |
| start | number Skips the amount of entries specified. Useful for paging. |
| type | string Filter the list results by the type field of the entities. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}POST_v1-entities
Insert a new entity into the system.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}PUT_v1-entities
Update all entities in the provided CDF.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v1-entities-uuid-origin
Delete entities using origin uuid or entity uuid list or both.
Authorizations:
query Parameters
| origin | string Entity origin uuid |
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
List of Entity uuid
Responses
Request samples
- Payload
[- "uuid1",
- "uuid2"
]Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-entities-purge
Delete all entities stored in Plexus. This creates a backup that can be restored at any time. Any subsequent purges overwrite the existing backup - but be very careful when using this endpoint.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-entities-reoriginate
Change the origin of every client' entity to the target.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| origin required | string Every entity with this origin will be re originated to the target id. |
| target required | string The new origin id. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| origin | string <uuid> |
| target | string <uuid> |
Responses
Request samples
- Payload
{- "origin": "11111111-0000-0000-0000-000000000000",
- "target": "00000000-0000-0000-0000-000000000000"
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-entities-restore Deprecated
Restores the state of entities before the previous purge. This means any new entries added after the purge was enacted will be overwritten by the previous state - be very careful when using this endpoint.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v1-entities-uuid
Delete an existing entity from the system by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-entities-uuid
Retrieve a single entity for the active subscription by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}PUT_v1-entities-uuid
Update an existing entity in the system by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string <url> |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-entities-uuid-reoriginate
Reoriginate an entity to an other client.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| target required | string The new origin id. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| target | string <uuid> |
Responses
Request samples
- Payload
{- "target": "00000000-0000-0000-0000-000000000000"
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-entities-uuid-revisions Deprecated
Retrieve a list about an entity revision.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}POST_v2-bulk-entities
Perform a large amount of operations on entities at once.
Authorizations:
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
Array of objects |
Responses
Request samples
- Payload
{- "actions": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "type": "delete"
}, - {
- "id": "00000000-0000-0000-0000-000000000000",
- "type": "update"
},
]
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-entities
List all entities pertaining to the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| fields | string The name of attributes to return, as a comma-separated list. |
| filter:{name} | string Any amount of attribute filters. The name is the name of the attribute to filter by, and the value is a wildcard string to compare against. |
| language | string If set, reduces the returned attributes by returning the only the value for the provided language, instead |
| limit | number Sets the amount of entries to return. Defaults to 1000. Maximum 3000 entries can be retrieved by a single request. |
| origin | string Filter the list results by the origin field of the entities. |
| start | number Skips the amount of entries specified. Useful for paging. |
| type | string Filter the list results by the type field of the entities. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}POST_v2-entities
Insert a new entity into the system.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}PUT_v2-entities
Update all entities in the provided CDF.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v2-entities-uuid-origin
Delete entities using origin uuid or entity uuid list or both.
Authorizations:
query Parameters
| origin | string Entity origin uuid |
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
List of Entity uuid
Responses
Request samples
- Payload
[- "uuid1",
- "uuid2"
]Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-entities-purge
Delete all entities stored in Plexus. This creates a backup that can be restored at any time. Any subsequent purges overwrite the existing backup - but be very careful when using this endpoint.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-entities-reoriginate
Change the origin of every client' entity to the target.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| origin required | string Every entity with this origin will be re originated to the target id. |
| target required | string The new origin id. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| origin | string <uuid> |
| target | string <uuid> |
Responses
Request samples
- Payload
{- "origin": "11111111-0000-0000-0000-000000000000",
- "target": "00000000-0000-0000-0000-000000000000"
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-entities-restore Deprecated
Restores the state of entities before the previous purge. This means any new entries added after the purge was enacted will be overwritten by the previous state - be very careful when using this endpoint.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v2-entities-uuid
Delete an existing entity from the system by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-entities-uuid
Retrieve a single entity for the active subscription by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}PUT_v2-entities-uuid
Update an existing entity in the system by uuid.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| resource | string <url> |
Responses
Request samples
- Payload
{
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-entities-uuid-reoriginate
Reoriginate an entity to an other client.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| target required | string The new origin id. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| target | string <uuid> |
Responses
Request samples
- Payload
{- "target": "00000000-0000-0000-0000-000000000000"
}Response samples
- 202
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-entities-uuid-revisions Deprecated
Retrieve a list about an entity revision.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- {
- "attributes": {
- "title": {
- "en": "Title"
}
}, - "created": "1985-04-12T23:20:50.52Z",
- "modified": "1985-04-12T23:20:50.52Z",
- "origin": "00000000-0000-4000-8000-000000000000",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
], - "success": true
}DELETE_v1-bulk-settings-webhooks-filters
Remove the filter from a set of webhooks.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-bulk-settings-webhooks-filters
Get a list of webhook_ids with assigned filter_id.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-bulk-settings-webhooks-filters
Add a new filter to a set of webhooks.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| filter_id | string <uuid> |
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "filter_id": "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0",
- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-settings
Returns information about the current subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "clients": [
- {
- "name": "client",
- "uuid": "00000000-0000-4000-8000-0000000000020"
}
], - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000",
- "webhooks": [
- {
- "client_name": "client",
- "client_uuid": "00000000-0000-4000-8000-0000000000020",
- "disable_retries": false,
- "uuid": "00000000-0000-4000-8000-0000000000001"
}
]
}DELETE_v1-settings-client-name-name
Delete a client by name.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-settings-client-name-name
Returns the client with the specified name. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v1-settings-client-name-name
Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| name | string |
Responses
Request samples
- Payload
{- "name": "foo"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v1-settings-client-uuid-uuid
Delete a client by uuid.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-settings-client-uuid-uuid
Returns the client with the specified uuid. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v1-settings-client-uuid-uuid
Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| name | string |
Responses
Request samples
- Payload
{- "name": "foo"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-settings-clients-name
Returns the client with the specified name. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v1-settings-concurrent_limit
Set the maximum number of active concurrent connections for a subscription. Limitation is always enabled, the default limit is 15.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| value required | number The new value of the setting. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| value | integer |
Responses
Request samples
- Payload
{- "value": 6
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-settings-secret
Regenerates the shared secret of the subscription. All clients must be updated after this request. A webhook message is sent to all listeners to notify them about this change.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v1-settings-webhooks
Creates a new webhook for the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| url required | string The URL where the webhook will be posted. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| disable_retries | boolean |
| limit | integer |
| url | string <url> |
| version | integer |
Responses
Request samples
- Payload
{- "disable_retries": false,
- "limit": 300,
- "version": 2
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "client_name": "client",
- "client_uuid": "00000000-0000-4000-8000-0000000000020",
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}GETT_v1-settings-webhooks-status
Reports the reahcability of all the webhooks for this account if uuid query param is blank or not provided otherwie return the reachability for the webhook identified by uuid
Authorizations:
query Parameters
| uuid | string Webhook unique identifier |
Responses
Response samples
- 200
{- "success": true,
- "request_id": "cb4f4261-8d0c-4fda-99e7-6772795c2d2a",
- "data": [
- {
- "uuid": "ce121f35-df0c-4f01-a7dd-945dbcc306bc",
- "current_state": "suppressed",
- "suppressed_until": 1622533524
}, - {
- "uuid": "4db0b3df-1c31-4174-b396-273715a0c3f6",
- "current_state": "disabled"
}, - {
- "uuid": "cc270899-a405-4e70-85ec-f8e5163f8bd7",
- "current_state": "healthy",
- "status": 200
}, - {
- "uuid": "f03e7aef-5755-4208-a3fd-b4f6702e07d6",
- "current_state": "unreachable",
- "reason": "error making an HTTP call: Post http://epveuvb.net/IFYLTHu: dial tcp: lookup epveuvb.net: no such host"
}
]
}DELETE_v1-settings-webhooks-uuid
Deletes the webhook with the specified uuid for the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "success": true
}PUT_v1-settings-webhooks-uuid
Update the webhook settings for the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| disable_retries | boolean |
| limit | integer |
| url | string <url> |
Responses
Request samples
- Payload
{- "disable_retries": false,
- "limit": 300,
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "request_id": "01010101-0101-4101-a101-010101010101",
- "success": true
}PUT_v1-settings-webhooks-uuid-enable
Enable a suppressed webhook in the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "request_id": "01010101-0101-4101-a101-010101010101",
- "success": true
}DELETE_v1-settings-webhooks-uuid-filters
Remove all filters from webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-settings-webhooks-uuid-filters
List webhook filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- "74a196d5-ab4a-48e9-b1c8-5360c86f07ad",
- "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0"
], - "request_id": "",
- "success": true
}POST_v1-settings-webhooks-uuid-filters
Add a new filter to webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| filter_id | string <uuid> |
Responses
Request samples
- Payload
{- "filter_id": "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}Remove the filter with the given filter id from we
Remove the filter with the given filter id from webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v2-bulk-settings-webhooks-filters
Remove the filter from a set of webhooks.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-bulk-settings-webhooks-filters
Get a list of webhook_ids with assigned filter_id.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-bulk-settings-webhooks-filters
Add a new filter to a set of webhooks.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| filter_id | string <uuid> |
| webhook | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "filter_id": "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0",
- "webhook": [
- "5c2d089b-d8e1-4c03-9239-9d294f8418fc",
- "8f606f2d-42ce-4319-8d71-bf20c9ed9623"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-settings
Returns information about the current subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "clients": [
- {
- "name": "client",
- "uuid": "00000000-0000-4000-8000-0000000000020"
}
], - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000",
- "webhooks": [
- {
- "client_name": "client",
- "client_uuid": "00000000-0000-4000-8000-0000000000020",
- "disable_retries": false,
- "uuid": "00000000-0000-4000-8000-0000000000001"
}
]
}DELETE_v2-settings-client-name-name
Delete a client by name.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-settings-client-name-name
Returns the client with the specified name. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v2-settings-client-name-name
Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| name | string |
Responses
Request samples
- Payload
{- "name": "foo"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v2-settings-client-uuid-uuid
Delete a client by uuid.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-settings-client-uuid-uuid
Returns the client with the specified uuid. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}PUT_v2-settings-client-uuid-uuid
Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.
Authorizations:
path Parameters
| clientID required | string The uuid of the client being manipulated by this API request. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| name | string |
Responses
Request samples
- Payload
{- "name": "foo"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-settings-clients-name
Returns the client with the specified name. Client ID is not required for this endpoint.
Authorizations:
path Parameters
| clientName required | string The name of the client being requested. For OPTIONS discovery, any value is accepted for this URI parameter. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v2-settings-concurrent_limit
Set the maximum number of active concurrent connections for a subscription. Limitation is always enabled, the default limit is 15.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| value required | number The new value of the setting. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| value | integer |
Responses
Request samples
- Payload
{- "value": 6
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-settings-secret
Regenerates the shared secret of the subscription. All clients must be updated after this request. A webhook message is sent to all listeners to notify them about this change.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}POST_v2-settings-webhooks
Creates a new webhook for the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| url required | string The URL where the webhook will be posted. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| disable_retries | boolean |
| limit | integer |
| url | string <url> |
| version | integer |
Responses
Request samples
- Payload
{- "disable_retries": false,
- "limit": 300,
- "version": 2
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "client_name": "client",
- "client_uuid": "00000000-0000-4000-8000-0000000000020",
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}GETT_v2-settings-webhooks-status
Reports the reahcability of all the webhooks for this account if uuid query param is blank or not provided otherwie return the reachability for the webhook identified by uuid
Authorizations:
query Parameters
| uuid | string Webhook unique identifier |
Responses
Response samples
- 200
{- "success": true,
- "request_id": "cb4f4261-8d0c-4fda-99e7-6772795c2d2a",
- "data": [
- {
- "uuid": "ce121f35-df0c-4f01-a7dd-945dbcc306bc",
- "current_state": "suppressed",
- "suppressed_until": 1622533524
}, - {
- "uuid": "4db0b3df-1c31-4174-b396-273715a0c3f6",
- "current_state": "disabled"
}, - {
- "uuid": "cc270899-a405-4e70-85ec-f8e5163f8bd7",
- "current_state": "healthy",
- "status": 200
}, - {
- "uuid": "f03e7aef-5755-4208-a3fd-b4f6702e07d6",
- "current_state": "unreachable",
- "reason": "error making an HTTP call: Post http://epveuvb.net/IFYLTHu: dial tcp: lookup epveuvb.net: no such host"
}
]
}DELETE_v2-settings-webhooks-uuid
Deletes the webhook with the specified uuid for the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "success": true
}PUT_v2-settings-webhooks-uuid
Update the webhook settings for the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| disable_retries | boolean |
| limit | integer |
| url | string <url> |
Responses
Request samples
- Payload
{- "disable_retries": false,
- "limit": 300,
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "request_id": "01010101-0101-4101-a101-010101010101",
- "success": true
}PUT_v2-settings-webhooks-uuid-enable
Enable a suppressed webhook in the active subscription.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "disable_retries": false,
- "url": "{url}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}, - "request_id": "01010101-0101-4101-a101-010101010101",
- "success": true
}DELETE_v2-settings-webhooks-uuid-filters
Remove all filters from webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-settings-webhooks-uuid-filters
List webhook filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": [
- "74a196d5-ab4a-48e9-b1c8-5360c86f07ad",
- "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0"
], - "request_id": "",
- "success": true
}POST_v2-settings-webhooks-uuid-filters
Add a new filter to webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| filter_id required | string UUID of a filter. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| filter_id | string <uuid> |
Responses
Request samples
- Payload
{- "filter_id": "d4e3ec2a-5b6f-4820-afe9-4b4e2fff21e0"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}Remove the filter with the given filter id from we
Remove the filter with the given filter id from webhook settings.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| filterID required | string filter uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-interest-:entity
Reports a list of all webhooks that are subscribed to the given entity
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
Responses
Response samples
- 200
{- "success": true,
- "request_id": "cb4f4261-8d0c-4fda-99e7-6772795c2d2a",
- "data": [
- {
- "client": {
- "name": "c-name-1",
- "uuid": "c-uuid-1"
}, - "webhook": {
- "url": "w-url-1",
- "uuid": "w-uuid-1"
}
}, - {
- "client": {
- "name": "c-name-n",
- "uuid": "c-uuid-n"
}, - "webhook": {
- "url": "w-url-n",
- "uuid": "w-uuid-n"
}
}
]
}POST_v1-interest-:entity
Add an interest marker for an entity for a specific webhook URL. Interest-marked entities will always send updates to the webhook URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| entity required | string The entity ID which is marked as an interested entity. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | string <uuid> |
| site_role | string |
| status | string |
| reason | string |
| event_ref | string <uuid> |
Responses
Request samples
- Payload
{- "webhook": "abababab-abab-abab-abab-abababcdcdcd",
- "site_role": "publisher",
- "status": "failed",
- "reason": "import failed",
- "event_ref": "1692171d-3c5f-448c-ad8c-4656ce265fdb"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v1-interest-:entity-:webhook
Remove an interest marker for an entity for a specific webhook URL. Interest-marked entities will always send updates to the webhook URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| entity required | string The entity ID which is marked as an interested entity. |
| webhook required | string The uuid of the webhook URL that is no longer interested in this entity. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-interest-webhook-:webhook-find
Query the interest list by the webhook.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "count": 2,
- "interests": [
- "00000000-0000-4000-8000-0000000000001",
- "00000000-0000-4000-8000-0000000000002"
]
}
}POST_v1-interest-webhook-:webhook-create
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| webhook required | string The webhook ID to attach the interests to. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| interests | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "interests": [
- "abababab-abab-abab-abab-abababcdcdcd",
- "abababab-abab-abab-abab-abababcdcdcd"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v1-interest-webhook-:site-role
Query the interest list by the webhook.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "4f5220bb-5f87-41ec-b03a-e20586063e38",
- "data": {
- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "SYNDICATION-IN-PROGRESS",
- "reason": "Syndication initiated",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "EXPORT-SUCCESSFUL",
- "reason": "Export successful.",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}
}POST_v1-interest-webhook-:webhook-attach
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
additional property | object |
Responses
Request samples
- Payload
{- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "READY-FOR-SYNDICATION",
- "reason": "Entity picked up for syndication",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "SYNDICATION-IN-PROGRESS",
- "reason": "Syndication initiated",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}POST_v1-interest-webhook-:webhook-update
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
additional property | object |
Responses
Request samples
- Payload
{- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "QUEUED-TO-EXPORT",
- "reason": "Export initiated",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "MPORT-FAILED",
- "reason": "Import failed due to XYZ issue.",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}Retrieve a list of clients of interest to a publis
Retrieve a list of clients of interest to a publisher
Authorizations:
path Parameters
| pub-uuid required | string The UUID of the publisher. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "4f5220bb-5f87-41ec-b03a-e20586063e38",
- "data": [
- {
- "client_uuid": "5t5220bb-5h87-41ep-b03a-e20586063e78",
- "client_name": "SubscriberA",
- "webhook_uuid": "5g5220bb-5h87-41ep-b03a-e20586063e98",
}
]
}GET_v2-interest-:entity
Reports a list of all webhooks that are subscribed to the given entity
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
Responses
Response samples
- 200
{- "success": true,
- "request_id": "cb4f4261-8d0c-4fda-99e7-6772795c2d2a",
- "data": [
- {
- "client": {
- "name": "c-name-1",
- "uuid": "c-uuid-1"
}, - "webhook": {
- "url": "w-url-1",
- "uuid": "w-uuid-1"
}
}, - {
- "client": {
- "name": "c-name-n",
- "uuid": "c-uuid-n"
}, - "webhook": {
- "url": "w-url-n",
- "uuid": "w-uuid-n"
}
}
]
}POST_v2-interest-:entity
Add an interest marker for an entity for a specific webhook URL. Interest-marked entities will always send updates to the webhook URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| entity required | string The entity ID which is marked as an interested entity. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| webhook | string <uuid> |
| site_role | string |
| status | string |
| reason | string |
| event_ref | string <uuid> |
Responses
Request samples
- Payload
{- "webhook": "abababab-abab-abab-abab-abababcdcdcd",
- "site_role": "publisher",
- "status": "failed",
- "reason": "import failed",
- "event_ref": "1692171d-3c5f-448c-ad8c-4656ce265fdb"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}DELETE_v2-interest-:entity-:webhook
Remove an interest marker for an entity for a specific webhook URL. Interest-marked entities will always send updates to the webhook URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| entityID required | string The uuid of the entity being manipulated by this API request. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| entity required | string The entity ID which is marked as an interested entity. |
| webhook required | string The uuid of the webhook URL that is no longer interested in this entity. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-interest-webhook-:webhook
Query the interest list by the webhook.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "count": 2,
- "interests": [
- "00000000-0000-4000-8000-0000000000001",
- "00000000-0000-4000-8000-0000000000002"
]
}
}POST_v2-interest-webhook-:webhook
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| webhook required | string The webhook ID to attach the interests to. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| interests | Array of strings <uuid> |
Responses
Request samples
- Payload
{- "interests": [
- "abababab-abab-abab-abab-abababcdcdcd",
- "abababab-abab-abab-abab-abababcdcdcd"
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true
}GET_v2-interest-webhook-:site-role-find
Query the interest list by the webhook.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "4f5220bb-5f87-41ec-b03a-e20586063e38",
- "data": {
- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "SYNDICATION-IN-PROGRESS",
- "reason": "Syndication initiated",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "EXPORT-SUCCESSFUL",
- "reason": "Export successful.",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}
}POST_v2-interest-webhook-:site-role
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
additional property | object |
Responses
Request samples
- Payload
{- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "READY-FOR-SYNDICATION",
- "reason": "Entity picked up for syndication",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "SYNDICATION-IN-PROGRESS",
- "reason": "Syndication initiated",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}PUT_v2-interest-webhook-:webhook
Add an interest markers for an entity for a specific webhooks URL. Interest-marked entities will always send updates to the webhooks URL when the entity is changed regardless of configured filters.
Authorizations:
path Parameters
| webhookID required | string webhook uuid |
| site-role required | string The site-role for the webhook. Possible values are ['PUBLISHER', 'SUBSCRIBER']. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
additional property | object |
Responses
Request samples
- Payload
{- "292240f5-a18c-4db2-81b3-57ede9e0d5ed": {
- "status": "QUEUED-TO-EXPORT",
- "reason": "Export initiated",
- "event_ref": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}, - "32a613ca-2503-4b32-99c6-ec5f0059da6e": {
- "status": "MPORT-FAILED",
- "reason": "Import failed due to XYZ issue.",
- "event_ref": "65d5c014-6b4e-4e6d-9182-95030db30568"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "62069dda-6d66-4bab-ba6b-8ca5f7c9e233"
}Retrieve a list of clients of interest to a publis
Retrieve a list of clients of interest to a publisher
Authorizations:
path Parameters
| pub-uuid required | string The UUID of the publisher. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "request_id": "4f5220bb-5f87-41ec-b03a-e20586063e38",
- "data": [
- {
- "client_uuid": "5t5220bb-5h87-41ep-b03a-e20586063e78",
- "client_name": "SubscriberA",
- "webhook_uuid": "5g5220bb-5h87-41ep-b03a-e20586063e98",
}
]
}POST_v1-register
Registers a new client for the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Request Body schema: application/json
| name required | string name of the client |
| originUUID | string origin UUID of client |
Responses
Request samples
- Payload
{- "name": "foo",
- "originUUID": "00000000-0000-4000-8000-000000000000"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}GET_v1-system-info Deprecated
Retrieve system level information about the subscription
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "webhook_queue_size": 0
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v1-token Deprecated
Create a temporary token with the same permissions as the signing key.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| ttl required | string Time to live (in seconds) |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| ttl | integer |
Responses
Request samples
- Payload
{- "ttl": 900
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "key": "acCEsS_Key",
- "secret_key": "53CR37_K3Y"
}, - "success": true
}POST_v2-register
Registers a new client for the active subscription.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Request Body schema: application/json
| name required | string name of the client |
| originUUID | string origin UUID of client |
Responses
Request samples
- Payload
{- "name": "foo",
- "originUUID": "00000000-0000-4000-8000-000000000000"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "name": "{name}",
- "uuid": "00000000-0000-4000-8000-000000000000"
}GET_v2-system-info Deprecated
Retrieve system level information about the subscription
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "webhook_queue_size": 0
}, - "success": true,
- "uuid": "00000000-0000-4000-8000-0000000000000"
}POST_v2-token Deprecated
Create a temporary token with the same permissions as the signing key.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| ttl required | string Time to live (in seconds) |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| ttl | integer |
Responses
Request samples
- Payload
{- "ttl": 900
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "key": "acCEsS_Key",
- "secret_key": "53CR37_K3Y"
}, - "success": true
}GET_v1-_mapping Deprecated
Retrieve active elasticsearch mapping of entities.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "entity": {
- "dynamic": "string",
- "properties": {
- "data": {
- "dynamic": "string",
- "properties": {
- "assets": {
- "dynamic": "string",
- "properties": {
- "replace-token": {
- "type": "string"
}, - "url": {
- "type": "string"
}
}
}, - "attributes": {
- "dynamic": "string",
- "properties": {
- "title": {
- "dynamic": "string",
- "properties": {
- "metadata": {
- "type": null
}, - "type": {
- "type": null
}, - "value": {
- "dynamic": null,
- "properties": { }
}
}
}
}
}, - "created": {
- "type": "string"
}, - "metadata": {
- "dynamic": "string",
- "index": "string",
- "type": "string"
}, - "modified": {
- "type": "string"
}, - "origin": {
- "type": "string"
}, - "type": {
- "type": "string"
}, - "uuid": {
- "type": "string"
}
}
}, - "id": {
- "type": "string"
}, - "origin": {
- "index": "string",
- "type": "string"
}, - "revision": {
- "type": "string"
}, - "subscription": {
- "type": "string"
}, - "uuid": {
- "index": "string",
- "type": "string"
}
}
}
}Forwards a search request to the Elastic Search se
Forwards a search request to the Elastic Search server. The search syntax is available at https://www.elastic.co/guide/en/elasticsearch/reference/1.5/index.html as of May 8th, 2019.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}Forwards a search request to the Elastic Search se
Forwards a search request to the Elastic Search server. The search syntax is available at https://www.elastic.co/guide/en/elasticsearch/reference/1.5/index.html as of May 8th, 2019.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
object | |
object | |
object |
Responses
Request samples
- Payload
{- "filter": {
- "term": {
- "data.attributes.weight.value.und": 35
}
}, - "query": {
- "match_all": { }
}, - "sort": {
- "data.modified": "desc"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}GET_v1-history Deprecated
Customer facing logs. Forwards a search request to the Elastic Search server
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "_index": "00000000-0000-4000-8000-000000000000_history_index",
- "_score": 1,
- "_source": {
- "client": "12340000-0000-4000-6012-000000000000",
- "entity": "eadc61e3-b847-4310-946a-511cca7bb14b",
- "id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "request_id": "71b983d5-169d-48d9-6f62-c474cbdd5454",
- "status": "succeeded",
- "subscription": "00000000-0000-4000-8000-000000000000",
- "timestamp": "2017-03-09T13:49:23Z",
- "type": "create"
}, - "_type": "history"
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}POST_v1-history Deprecated
Customer facing logs. Forwards a search request to the Elastic Search server
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Request Body schema: application/json
object | |
object | |
object |
Responses
Request samples
- Payload
{- "query": {
- "bool": {
- "filter": [
- {
- "term": {
- "entity": "a63be6be-d047-49b6-869c-8df07ebfa288"
}
}
]
}
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "_index": "00000000-0000-4000-8000-000000000000_history_index",
- "_score": 1,
- "_source": {
- "client": "12340000-0000-4000-6012-000000000000",
- "entity": "eadc61e3-b847-4310-946a-511cca7bb14b",
- "id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "request_id": "71b983d5-169d-48d9-6f62-c474cbdd5454",
- "status": "succeeded",
- "subscription": "00000000-0000-4000-8000-000000000000",
- "timestamp": "2017-03-09T13:49:23Z",
- "type": "create"
}, - "_type": "history"
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}GET_v2-_mapping Deprecated
Retrieve active elasticsearch mapping of entities.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "entity": {
- "dynamic": "string",
- "properties": {
- "data": {
- "dynamic": "string",
- "properties": {
- "assets": {
- "dynamic": "string",
- "properties": {
- "replace-token": {
- "type": "string"
}, - "url": {
- "type": "string"
}
}
}, - "attributes": {
- "dynamic": "string",
- "properties": {
- "title": {
- "dynamic": "string",
- "properties": {
- "metadata": {
- "type": null
}, - "type": {
- "type": null
}, - "value": {
- "dynamic": null,
- "properties": { }
}
}
}
}
}, - "created": {
- "type": "string"
}, - "metadata": {
- "dynamic": "string",
- "index": "string",
- "type": "string"
}, - "modified": {
- "type": "string"
}, - "origin": {
- "type": "string"
}, - "type": {
- "type": "string"
}, - "uuid": {
- "type": "string"
}
}
}, - "id": {
- "type": "string"
}, - "origin": {
- "index": "string",
- "type": "string"
}, - "revision": {
- "type": "string"
}, - "subscription": {
- "type": "string"
}, - "uuid": {
- "index": "string",
- "type": "string"
}
}
}
}GET_v2-_search
Forwards a search request to the Elastic Search server. The search syntax is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.3/index.html as of May 8th, 2019.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}POST_v2-_search
Forwards a search request to the Elastic Search server. The search syntax is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.3/index.html as of May 8th, 2019.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
object | |
object | |
object |
Responses
Request samples
- Payload
{- "filter": {
- "term": {
- "data.attributes.weight.value.und": 35
}
}, - "query": {
- "match_all": { }
}, - "sort": {
- "data.modified": "desc"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 0,
- "total": 0
}, - "hits": {
- "hits": [
- {
- "_shard": {
- "data": {
- "attributes": {
- "title": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]
}
}GET_v2-history Deprecated
Customer facing logs. Forwards a search request to the Elastic Search server
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "_index": "00000000-0000-4000-8000-000000000000_history_index",
- "_score": 1,
- "_source": {
- "client": "12340000-0000-4000-6012-000000000000",
- "entity": "eadc61e3-b847-4310-946a-511cca7bb14b",
- "id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "request_id": "71b983d5-169d-48d9-6f62-c474cbdd5454",
- "status": "succeeded",
- "subscription": "00000000-0000-4000-8000-000000000000",
- "timestamp": "2017-03-09T13:49:23Z",
- "type": "create"
}, - "_type": "history"
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}POST_v2-history Deprecated
Customer facing logs. Forwards a search request to the Elastic Search server
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
Request Body schema: application/json
object | |
object | |
object |
Responses
Request samples
- Payload
{- "query": {
- "bool": {
- "filter": [
- {
- "term": {
- "entity": "a63be6be-d047-49b6-869c-8df07ebfa288"
}
}
]
}
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "_index": "00000000-0000-4000-8000-000000000000_history_index",
- "_score": 1,
- "_source": {
- "client": "12340000-0000-4000-6012-000000000000",
- "entity": "eadc61e3-b847-4310-946a-511cca7bb14b",
- "id": "7257fb6e-2fba-4919-6311-656385295b2f",
- "request_id": "71b983d5-169d-48d9-6f62-c474cbdd5454",
- "status": "succeeded",
- "subscription": "00000000-0000-4000-8000-000000000000",
- "timestamp": "2017-03-09T13:49:23Z",
- "type": "create"
}, - "_type": "history"
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}DELETE_v2-scroll
End scroll with scroll id
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| scroll_id | integer |
Responses
Request samples
- Payload
{- "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}Response samples
- 200
{- "success": true
}POST_v2-scroll
Forwards a search request to the Elastic Search server with scroll option, and will return a scroll id. The search syntax is available at https://www.elastic.co/guide/en/elasticsearch/reference/6.3/index.html as of May 8th, 2019.
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| scroll | integer the scroll window expiry time, the time unit is minute, default value is 30 which means the scroll window will last 30 minutes |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| from | integer |
object | |
object | |
| size | integer |
object |
Responses
Request samples
- Payload
{- "from": 0,
- "highlight": {
- "fields": {
- "*": { }
}
}, - "query": {
- "bool": {
- "filter": [
- {
- "term": {
- "data.attributes.weight.value.und": 35
}
}
]
}
}, - "size": 24,
- "sort": {
- "data.modified": "desc"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_source": {
- "data": {
- "attributes": {
- "title": {
- "type": "string",
- "value": "Article title"
}
}, - "uuid": "00000000-0000-4000-8000-000000000000"
}, - "origin": "00000000-0000-4000-6000-000000000000",
- "type": "article",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}POST_v2-scroll-continue
With scroll id returned by scroll endpoint, will return next X results of scroll
Authorizations:
query Parameters
| account_id | string The lift account ID or acquia subscription ID to use for the request. The ID must be tied to the ID used in the authentication service. |
| scroll | integer the scroll window expiry time, the time unit is minute, default value is 30 which means the scroll window will last 30 minutes |
header Parameters
| X-Acquia-Plexus-Client-Id required | string A required header which contains the client ID for the client that is making the request. |
Request Body schema: application/json
| scroll | string |
| scroll_id | string |
Responses
Request samples
- Payload
{- "scroll": "1",
- "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "_scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
- "_shards": {
- "failed": 0,
- "successful": 5,
- "total": 5
}, - "hits": {
- "hits": [
- {
- "_source": {
- "data": {
- "attributes": {
- "title": {
- "type": "string",
- "value": "Article title"
}
}, - "uuid": "00000000-0000-4000-8000-000000000000"
}, - "origin": "00000000-0000-4000-6000-000000000000",
- "type": "article",
- "uuid": "00000000-0000-4000-8000-000000000000"
}
}
], - "total": 1
}, - "timed_out": false,
- "took": 63
}Checks whether system is healthy/ailing/unhealthy
Checks whether system is healthy/ailing/unhealthy by computing TP90 of response time over given number of days.
Authorizations:
path Parameters
| numDays required | integer [ 7 .. 30 ] The number of days for which the system health status should be returned. |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "request_id": "00000000-0000-4000-8000-000000000000",
- "success": true,
- "data": {
- "status": "healthy",
- "results": [
- {
- "date": "2022-04-28",
- "art": 3
}
]
}
}