API Endpoints

/ping

get

Responds with a 200 OK response when the service is available.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

/v1

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Retrieve active elasticsearch mapping of entities.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Perform a large amount of operations on entities at once.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

delete

Remove the filter from a set of webhooks.

get

Get a list of webhook_ids with assigned filter_id.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Add a new filter to a set of webhooks.

get

List all entities pertaining to the active subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Insert a new entity into the system.

put

Update all entities in the provided CDF.

delete

Delete an existing entity from the system by uuid.

get

Retrieve a single entity for the active subscription by uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

put

Update an existing entity in the system by uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Reoriginate an entity to an other client.

get

Retrieve a list about an entity revision.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Change the origin of every client' entity to the target.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Restores the state of entities before the previous purge. This means any new entries added after the purge was enacted will be overwritted by the previous state - be very careful when using this endpoint.

get

List cloud filters tied to the account. Or get cloud filter by its name

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

put

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.

delete

Delete a single cloud filter from your account.

get

Retrieve data about a single cloud filter tied to your account.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Subscribe to a filter.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Subscribe to a filter.

put

Update a filter subscription.

delete

Unsubscribe to a filter.

get

Subscribe to a filter.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Customer facing logs. Forwards a search request to the Elastic Search server

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Customer facing logs. Forwards a search request to the Elastic Search server

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

delete

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.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Query the interest list by the webhook.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Registers a new client for the active subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Schedules a reindex process

get

Returns information about the current subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

delete

Delete a client by name.

get

Returns the client with the specified name. Client ID is not required for this endpoint.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

put

Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

delete

Delete a client by uuid.

get

Returns the client with the specified name. Client ID is not required for this endpoint.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

put

Modify a registered client with provided name. Modifications may be done to any attribute other than the uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Returns the client with the specified name. Client ID is not required for this endpoint.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Set the maximum number of active concurrent connections for a subscription. Limitation is always enabled, the default limit is 15.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Creates a new webhook for the active subscription.

delete

Deletes the webhook with the specified uuid for the active subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

put

Update the webhook settings for the active subscription.

delete

Remove all filters from webhook settings.

get

List webhook filters.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Add a new filter to webhook settings.

delete

Remove the filter with the given filter id from webhook settings.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Retrieve system level information about the subscription

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Create a temporary token with the same permissions as the signing key.

/v2

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Retrieve active elasticsearch mapping of entities.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Perform a large amount of operations on entities at once.

get

List all entities pertaining to the active subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Insert a new entity into the system.

put

Update all entities in the provided CDF.

delete

Delete an existing entity from the system by uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

put

Update an existing entity in the system by uuid.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Reoriginate an entity to an other client.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Change the origin of every client' entity to the target.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Restores the state of entities before the previous purge. This means any new entries added after the purge was enacted will be overwritted by the previous state - be very careful when using this endpoint.

get

List cloud filters tied to the account. Or get cloud filter by its name

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

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.

put

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.

delete

Delete a single cloud filter from your account.

get

Retrieve data about a single cloud filter tied to your account.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

List filter subscriptions.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Subscribe to a filter.

put

Update a filter subscription.

delete

Unsubscribe to a filter.

get

Get a single filter subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

get

Customer facing logs. Forwards a search request to the Elastic Search server

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Customer facing logs. Forwards a search request to the Elastic Search server

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Registers a new client for the active subscription.

options

API exploration using HTTP OPTIONS. Returns information about this endpoint. Does not require authentication.

post

Schedules a reindex process

Security schemes

hmac_v1

Deprecated.
Plexus supports HMAC based authorization for securing all API requests.
HMAC authentication is a shared-secret cryptography method where signatures are generated on the client side and validated by the server in order to authenticate the request.

hmac_v2

Plexus supports HMAC based authorization for securing all API requests.
HMAC authentication is a shared-secret cryptography method where signatures are generated on the client side and validated by the server in order to authenticate the request.