Stacks - Create & Edit Workspaces

LIST WORKSPACES

To get a list of all existing Workspaces (stacks), perform a GET request:

curl -X GET \
 https://YOUR_STACK.datatap.adverity.com/api/stacks/ \
 -H 'Authorization: Token TOKEN_VALUE' \

This will return a list of all existing Workspaces, including meta information on each one, e.g. assigned Destination, parent, number of Datastreams, etc.

Result (cropped for just one Workspace)

{
 "count": XX,
 "next": null,
 "previous": null,
 "results": [
 {
 "add_connection_url": "/core/authorization/add/",
 "add_datastream_url": "/core/apidatastream/add/",
 "change_url": "/core/stack/STACK_ID/change/",
 "datalake": "https://YOUR_STACK.adverity.com/api/storage/DATALAKE_ID/",
 "destination": DESTINATION_ID,
 "extracts_url": "/core/datastreamextract/?stack_id=STACK_ID",
 "issues_url": "/core/datastreamextractionlog/?ack__exact=0&stack_id=STACK_ID",
 "id": STACK_ID,
 "name": "STACK_NAME",
 "overview_url": "/STACK_URL/",
 "parent": "https://YOUR_STACK.datatap.adverity.com/api/stacks/default/",
 "parent_id": PARENT_ID,
 "slug": "STACK_SLUG",
 "url": "https://YOUR_STACK.datatap.adverity.com/api/stacks/STACK_SLUG/",
 "counts": {
 "connections": XY,
 "datastreams": XZ
 },
 "permissions": {
 "isDatastreamManager": true
 },
 "default_manage_extract_names": true
 }
 ]
}

CREATE A NEW WORKSPACE

To create a Workspace, first perform an OPTIONS call and then perform a POST request accordingly. To create a new Workspace, the following elements are required:

1. Storage: DATALAKE_ID
2. Workspace name: NAME

WORKSPACE INFORMATION RETRIEVAL

To retrieve information about an existing Workspace, use the STACK_SLUG of the Workspace (not the ID) to perform a GET request.

curl -X GET \
 https://YOUR_STACK.datatap.adverity.com/api/stacks/STACK_SLUG\
 -H 'Authorization: Token TOKEN_VALUE' \

To update an existing Workspace, perform a PATCH request. Please note that even if you change the Workspace name (whether in the UI or through the API), the Workspace should be called using its initial short name, the STACK_SLUG.