Clone workspace

Clones a specific workspace in your organization, copying over connections and datasets from the original workspace. If you have connections or datasets that use workspace variables, those will be honored in the new workspace.

Request schema

Path parameters

workspace_id

integerrequired

ID of the workspace

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

new_workspace_name

stringrequired

The name for the new cloned workspace.

application_variables

array

Optional. An array of key-value pairs representing workspace variables for the new workspace. All variable keys used in the base workspace must be provided for the cloned workspace.

key

stringrequired

The key of the workspace variable. Cannot contain whitespaces.

value

undefinedrequired

The value of the workspace variable.

return_workspace_api_key

boolean

Whether or not a successful result should include the api_key field in the response. This workspace api_key is used to interact with the Workspace APIs.

example:

true

Http + 1.1

POST

https://app.getcensus.com/api/v1/workspaces/{workspace_id}/clone

POST /api/v1/workspaces/{workspace_id}/clone HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 161

{
  "new_workspace_name": "string",
  "application_variables": [
    {
      "key": "string",
      "value": null
    }
  ],
  "return_workspace_api_key": true
}

Responses

202

Successfully issued a clone of a workspace. The clone is in progress. To find the status of the clone use the status_endpoint returned.

401

Invalid credentials for the requested resource.

403

The feature you're trying to use is not available for your organization.

404

Resource not found.

`202`

status_endpoint

string

The url of the new workspace's clone status.

example:

https://app.getcensus.com/api/v1/workspaces/1123/clone_status

data

object

integer

The id of the retrieved workspace.

example:

123

name

string

The name of the workspace. Must be unique within the organization.

example:

My Workspace

organization_id

integer

The id of the organization the workspace belongs to.

example:

created_at

string

The timestamp of when the workspace was created.

format:

date-time

example:

2023-09-05T19:42:42.672Z

notification_emails

array

The list of emails that will receive alerts from the workspace.

example:

[ "notifications@mycompany.slack.com" ]

type:

string

api_key

string

The API key of the workspace.

example:

YourAPIKeyHere

`401`

status

integer

HTTP status code.

enum:

"401"

`403`

status

integer

HTTP status code.

enum:

"403"

message

string

Error message.

example:

The feature you're trying to use is not available for your organization.

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status_endpoint": "https://app.getcensus.com/api/v1/workspaces/1123/clone_status",
  "data": {
    "id": 123,
    "name": "My Workspace",
    "organization_id": 1,
    "created_at": "2023-09-05T19:42:42.672Z",
    "notification_emails": [
      "notifications@mycompany.slack.com"
    ],
    "api_key": "YourAPIKeyHere"
  }
}