Nexla Rest API (v1)

Nexla Support: support@nexla.com URL: https://nexla.zendesk.com License: Nexla Terms of Service

Introduction

The Nexla API is a REST-ful API used to easily create and manage resources in Nexla in ways that best fit any use case. It can be used to configure and monitor data flows for different data-integration use cases and to perform all aspects of data engineering automation offered by the Nexla platform.

The Nexla API supports all data flow-creation and -management actions in the platform, as well as administrative user- and organization-level account-management tasks. Note that all other client packages, such as the Nexla CLI and Nexla UI, also connect to the overall Nexla infrastructure through the Nexla API.

The API references in this document lists all API endpoints and the corresponding payloads.

Check out the API Developer Guides to view guides and tutorials for recommended use cases for different endpoints.

API Data Format and Versions

The API uses JSON for all data exchanges.

You should specify the API version that should be used in the Accept header of each request. For example, to access Version 1 of the API, the Accept header should be the following:

Accept: application/vnd.nexla.api.v1+json

The Nexla API also supports a generic version header, which will default your access to the latest version of the data source/destination API.

Accept: application/json

Authentication

Most Nexla API endpoints require Bearer Token authentication mechanism for making an authenticated request to the API. While this token can be generated programmatically outside Nexla UI by starting a session with an api_key, unless unavoidable, we recommend starting your session from the Nexla UI and using the Nexla Session Token from the Nexla UI as the Authorization header for calls to the Nexla API.

NexlaSessionToken

The first step in calling the Nexla API or Nexla CLI is to fetch a Session access token by logging on to your Nexla UI instance. This ensures that your authentication is performed through your organization's preferred Identity Provider.

To fetch an access token from the Nexla UI, simply go to your Nexla UI instance, and try the route /token. For example, if your Nexla UI instance is at https://dataops.nexla.io, open https://dataops.nexla.io/token in the browser.

This will automatically route you to a login page, ask you to authenticate using your preferred Identity Provider, and, upon successful authentication, route you to a page where you can copy the Access Token.

Usage format: Bearer <JWT>.

Security Scheme Type: HTTP

HTTP Authorization Scheme: Bearer

NexlaApiKeyQuery

Important: Never share your API keys. Keep them guarded and secure. If you think the key has been compromised, you can rotate the API key by calling relevant API Key management endpoints.

The platform generates a unique API key for this resource. Add the API key as a query parameter to authenticate this request. Usage: ?api_key=<api-key>

Security Scheme Type: API Key

Query parameter name: api_key

NexlaApiKeyHeader

Important: Never share your API keys. Keep them guarded and secure. If you think the key has been compromised, you can rotate the API key by calling relevant API Key management endpoints.

The platform generates a unique API key for this resource. Add the API key as an authorization header to authenticate this request. Usage format: Basic <api-key>

Security Scheme Type: HTTP

HTTP Authorization Scheme: Basic

basicAuth

Security Scheme Type: HTTP

HTTP Authorization Scheme: basic

GoogleSSOToken

The token that is used when logging into Nexla via Google SSO.

Security Scheme Type: HTTP

HTTP Authorization Scheme: Bearer

Session Management

Operations for managing your Nexla session programmatically.

Note: Unless unavoidable, we recommend starting your session from the Nexla UI and using the Nexla Session Token from the Nexla UI as the Authorization header for calls to the Nexla API.

Login with Basic Authentication

Use this endpoint for authentication if your organization allows basic authentication. A successful authentication attempt will result in an access_token that can be used to make authenticated requests to other API endpoints. The access_token automatically expires after a fixed duration, but you can also call the /logout endpoint to invalidate the access token at the end of your session.

Nexla supports various methods of authentication, including Basic (email/password), Google SSO, and custom SAML- or OIDC-based SSO. One or more of these methods might be allowed in any organization, depending on the configuration chosen by the administrators. Instead of using this endpoint to start a session programmatically, we recommend performing authentication through the Nexla UI and using the Nexla Session Token (available in Tools >> Nexla Session Token) to connect to the API programmatically.

Note: A user might belong to multiple organizations. This method initiates an authenticated session in their default organization.

Authorizations:

basicAuth

Responses

Response samples

200

Content type

application/json

{"access_token": "string",
"token_type": "Bearer",
"expires_in": 0,
"user": {"id": 0,
"full_name": "string",
"email": "string",
"org": 0,
"impersonated": true,
"impersonator": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z",
"org": 0
}
},
"org_membership": {"api_key": "string",
"status": "ACTIVE",
"is_admin?": true
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
}
}

Logout

Ends the current session and invalidates the NexlaSessionToken for future requests.

Authorizations:

NexlaSessionToken

Responses

Flows

Operations for managing flows.

Get All Flows

Returns all flows accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

flows_only	integer Value: 1 By default, flows responses include sub-lists of the resources included in the `flows`, such as `data_sources`, `data_sets` and `data_sinks`. If you do not need resource details and just need flow chain, include the `flows_only` query parameter in your request. This option can improve request response time significantly.
page	integer Add this parameter to a resource fetch request to fetch a specific page of data.
per_page	integer Add this parameter to a resource fetch request to set the number of items that should be returned in each request.
access_role	string Enum: "collaborator" "operator" "admin" "owner" Add this query parameter to a request to view resources for which the authenticated user has permission. `collaborator`: Resources to which the user has access via the collaborator or higher permissions. `operator`: Resources to which the user has access via the operator or higher permissions. `admin`: Resources to which the user has access via the administrator or owner permissions. `owner`: Resources created by the user. Note that the absence of this property in the request is treated as `owner`, so you do not need to set `access_role=owner` in the query. Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Get Flow by ID

Returns a flow object if a valid flow ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

flow_id

required

integer

The unique ID of the flow that needs to be fetched.

query Parameters

flows_only

integer

Value: 1

By default, flows responses include sub-lists of the resources included in the flows, such as data_sources, data_sets and data_sinks. If you do not need resource details and just need flow chain, include the flows_only query parameter in your request. This option can improve request response time significantly.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Delete a Flow

Deletes a flow from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

flow_id

required

integer

The unique ID of the flow that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Activate a Flow

To activate the entire flow, use either the origin_node_id from any data source, set or sink in the flow, or include the ?all=1 or ?full_tree=1 query parameter.

Note:

All endpoints for activating or pausing a flow operate on the specific resource given and all of the flow nodes downstream from that resource. This allows for pausing and activating sub-flows while leaving the rest of the flow state unchanged.

You can also activate a flow by using the id of the data_source/ data_set / data_sink that the flow node is linked to. See relevant endpoints in the API references for those resources.

Authorizations:

NexlaSessionToken

path Parameters

flow_id required	integer The unique ID of the flow that needs to be activated.
all	integer Value: 1 Set this query parameter if the flow node ID you are making a call with is not an origin flow node but you want to activate the full flow chain. Not necessary if the flow node is an origin flow node.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Pause a Flow

To pause the entire flow, use either the origin_node_id from any data source, set or sink in the flow, or include the ?all=1 or ?full_tree=1 query parameter.

Note:

All endpoints for activating or pausing a flow operate on the specific resource given and all of the flow nodes downstream from that resource. This allows for pausing and activating sub-flows while leaving the rest of the flow state unchanged.

You can also pause a flow by using the id of the data_source/ data_set / data_sink that the flow node is linked to. See relevant endpoints in the API references for those resources.

Authorizations:

NexlaSessionToken

path Parameters

flow_id required	integer The unique ID of the flow that needs to be paused.
all	integer Value: 1 Set this query parameter if the flow node ID you are making a call with is not an origin flow node but you want to pause the full flow chain. Not necessary if the flow node is an origin flow node.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Copy a Flow

Use this endpoint to create a copy of an existing flow.

Authorizations:

NexlaSessionToken

path Parameters

flow_id

required

integer

The unique ID of the flow that needs to be paused.

Request Body schema: application/vnd.nexla.api.v1+json

reuse_data_credentials	boolean Set this to `true` if you do want to reuse the credentials of this flow instead of creating a clone of the credentials also.
copy_access_controls	boolean Set this to `true` if you want the new flow to be accessible by all users who have access to the this flow.
copy_dependent_data_flows	boolean This is relevant for flows where one or more destinations have sources as their children. Set this to `true` if you want to create a clone of the flows that originate from those sources also.
owner_id	integer The default API behavior is to create the new flow in the account of the authenticated user making this call. Set this property if you want a different user to be the owner of the new flow.
org_id	integer The default API behavior is to create the new flow in the org that the authenticated user making this call belongs to. Set this property if you want the flow to be created in a different org.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"reuse_data_credentials": true,
"copy_access_controls": true,
"copy_dependent_data_flows": true,
"owner_id": 0,
"org_id": 0
}

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Get Flow (by Resourcce ID)

Returns a flow object if a valid resource type and resource ID is provided.

Note: This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.

query Parameters

flows_only

integer

Value: 1

By default, flows responses include sub-lists of the resources included in the flows, such as data_sources, data_sets and data_sinks. If you do not need resource details and just need flow chain, include the flows_only query parameter in your request. This option can improve request response time significantly.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Delete a Flow (by Resourcce ID)

Deletes a flow from your Nexla account.

Note: This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Activate a Flow (with Resource ID)

To activate the entire flow include the ?all=1 or ?full_tree=1 query parameter.

Note:

All endpoints for activating or pausing a flow operate on the specific resource given and all of the flow nodes downstream from that resource. This allows for pausing and activating sub-flows while leaving the rest of the flow state unchanged.

This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.
all	integer Value: 1 Set this query parameter if the resource ID you are making a call with is not an origin flow node but you want to activate the full flow chain. Not necessary if the flow node is an origin flow node.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Pause a Flow (with Resource ID)

To pause the entire flow include the entire flow include the ?all=1 or ?full_tree=1 query parameter.

Note:

All endpoints for activating or pausing a flow operate on the specific resource given and all of the flow nodes downstream from that resource. This allows for pausing and activating sub-flows while leaving the rest of the flow state unchanged.

This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.
all	integer Value: 1 Set this query parameter if the flow node ID you are making a call with is not an origin flow node but you want to pause the full flow chain. Not necessary if the flow node is an origin flow node.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Sources

Operations for managing data sources.

Get All Sources

Returns all data sources accessible to the authenticated user.

Nexla Rest API guide for Data Sources

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"status": "string",
"ingest_method": "string",
"source_format": "string",
"managed": true,
"code_container_id": 0,
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"access_roles": ["owner"
],
"auto_generated": true,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"data_sets": [ ],
"tags": [ ],
"flow_type": "string",
"run_ids": [ ],
"has_template": true,
"vendor_endpoint": {"id": 0,
"name": "string",
"display_name": "string"
},
"vendor": {"id": 0,
"name": "string",
"display_name": "string",
"connection_type": "string"
}
}
]

Create a Source

Creates a new data source in the authenticated user's account.

Depending on the type of source you want to create (source_type), properties like source_config and data_credentials_id will require appropriate configuration.

Note: name, source_type, source_config and data_credentials_id are required.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name

string

description

string

data_credentials_id

integer

Credential ID: Nexla data credential that contains all authentication information for this source.

Note that this is not applicable for file_upload, nexla_rest and email sources but is required for all other connectors.

source_type

string

Connector Type: Connector codename.

as400

object

start.cron required	string Scheduling Frequency: The interval at which Nexla should scan this source for new data. This must be in the form of a cron expression.
db_query_mode required	string Enum: "Default" "Query" Database Fetch Mode: Database connectors are designed to support self-serve capabilities for use cases ranging from simple table ingestion to ingestion based on complex custom queries. `Default`: Equivalent to running a simple (but optimized) SELECT clause on any database table, along with some additional customizations for filtering rows. `Query`: Execute data fetching based on a custom database query using the syntax and convention supported by the underlying database/warehouse.
query	string Query: Set the Query to be executed during each ingestion cycle. Required if `db_query_mode` is `Query`
database	string Database: Database whose table needs to be scanned for data. Required if `db_query_mode` is `Default`
table	string Table: Table that needs to be scanned for data. Required if `db_query_mode` is `Default`
mode	string Enum: "none" "incrementing" "timestamp" "incrementing,timestamp" Table Scan Mode: The default configuration of Table Mode is set to read all data in a table in each ingestion cycle, which is equivalent to a running `SELECT` clause on the table. However, when the table contains much more historical data than you wish to scan, you can instruct the platform to begin loading from a specific id (stored in a numeric column), timestamp (stored in a date-time column) or both id and timestamp. You can use the relevant Table Scan Mode to address this use case of partial loading from a table. Note that this can also be achieved by writing a properly structured query in Query Mode. Only applicable if `db_query_mode` is `Default` Default Value: `none` `none`: Read the whole table `incrementing`: Start reading from a specific ID `timestamp`: Start reading from a specific timestamp `incrementing,timestamp`: Start reading from a specific ID and timestamp
incrementing.column.name	string ID Column: The ID column that should be used for executing partial data loading from the selected table. This must be a numeric column. Only applicable if `db_query_mode` is `Default` and `mode` is `incrementing` or `incrementing,timestamp`
incrementing.load.from	string Starting ID: The starting ID value of ID Column from which the platform should start ingesting data. Only applicable if `db_query_mode` is `Default` and `mode` is `incrementing` or `incrementing,timestamp`
timestamp.column.name	string Timestamp Column: The timestamp column that should be used for executing partial data loading from the selected table. This must be a date-time column. Only applicable if `db_query_mode` is `Default` and `mode` is `timestamp` or `incrementing,timestamp`
	integer or string Starting Timestamp: The timestamp value of the Timestamp Column from which the platform should start ingesting data. This must be a UNIX epoch- (milliseconds) or ISO-formatted date value (e.g., 2016-01-01T12:13:14). Only applicable if `db_query_mode` is `Default` and `mode` is `timestamp` or `incrementing,timestamp`
commit.on.read	string <boolean> Enum: "false" "true" Perform Database Commit after Read?: You can instruct the platform to execute a database commit if the query includes statements that should also be committed to the database after ingestion. This is typically not the case, so most of the time, the value should be left as false. Only applicable if `db_query_mode` is `Query` Default Value: `"false"`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"data_credentials_id": 0,
"source_type": "as400",
"source_config": {"start.cron": "0 0 22 10 11 ? 2022",
"db_query_mode": "Default",
"query": "string",
"database": "string",
"table": "string",
"mode": "none",
"incrementing.column.name": "string",
"incrementing.load.from": "string",
"timestamp.column.name": "string",
"timestamp.load.from": 0,
"commit.on.read": "false"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Get Source by ID

Returns a source object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be fetched.

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Update a Source

Updates a data source in the authenticated user's account.

Depending on the type of source you want to update (source_type), properties like source_config and data_credentials_id will require appropriate configuration.

Note: This method does not perform partial updating of source_config. The entire source_config object will be updated if this is added to the payload.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be updated.

Request Body schema: application/json

name

string

description

string

data_credentials_id

integer

Credential ID: Nexla data credential that contains all authentication information for this source.

Note that this is not applicable for file_upload, nexla_rest and email sources but is required for all other connectors.

source_type

string

Connector Type: Connector codename.

as400

object

start.cron required	string Scheduling Frequency: The interval at which Nexla should scan this source for new data. This must be in the form of a cron expression.
db_query_mode required	string Enum: "Default" "Query" Database Fetch Mode: Database connectors are designed to support self-serve capabilities for use cases ranging from simple table ingestion to ingestion based on complex custom queries. `Default`: Equivalent to running a simple (but optimized) SELECT clause on any database table, along with some additional customizations for filtering rows. `Query`: Execute data fetching based on a custom database query using the syntax and convention supported by the underlying database/warehouse.
query	string Query: Set the Query to be executed during each ingestion cycle. Required if `db_query_mode` is `Query`
database	string Database: Database whose table needs to be scanned for data. Required if `db_query_mode` is `Default`
table	string Table: Table that needs to be scanned for data. Required if `db_query_mode` is `Default`
mode	string Enum: "none" "incrementing" "timestamp" "incrementing,timestamp" Table Scan Mode: The default configuration of Table Mode is set to read all data in a table in each ingestion cycle, which is equivalent to a running `SELECT` clause on the table. However, when the table contains much more historical data than you wish to scan, you can instruct the platform to begin loading from a specific id (stored in a numeric column), timestamp (stored in a date-time column) or both id and timestamp. You can use the relevant Table Scan Mode to address this use case of partial loading from a table. Note that this can also be achieved by writing a properly structured query in Query Mode. Only applicable if `db_query_mode` is `Default` Default Value: `none` `none`: Read the whole table `incrementing`: Start reading from a specific ID `timestamp`: Start reading from a specific timestamp `incrementing,timestamp`: Start reading from a specific ID and timestamp
incrementing.column.name	string ID Column: The ID column that should be used for executing partial data loading from the selected table. This must be a numeric column. Only applicable if `db_query_mode` is `Default` and `mode` is `incrementing` or `incrementing,timestamp`
incrementing.load.from	string Starting ID: The starting ID value of ID Column from which the platform should start ingesting data. Only applicable if `db_query_mode` is `Default` and `mode` is `incrementing` or `incrementing,timestamp`
timestamp.column.name	string Timestamp Column: The timestamp column that should be used for executing partial data loading from the selected table. This must be a date-time column. Only applicable if `db_query_mode` is `Default` and `mode` is `timestamp` or `incrementing,timestamp`
	integer or string Starting Timestamp: The timestamp value of the Timestamp Column from which the platform should start ingesting data. This must be a UNIX epoch- (milliseconds) or ISO-formatted date value (e.g., 2016-01-01T12:13:14). Only applicable if `db_query_mode` is `Default` and `mode` is `timestamp` or `incrementing,timestamp`
commit.on.read	string <boolean> Enum: "false" "true" Perform Database Commit after Read?: You can instruct the platform to execute a database commit if the query includes statements that should also be committed to the database after ingestion. This is typically not the case, so most of the time, the value should be left as false. Only applicable if `db_query_mode` is `Query` Default Value: `"false"`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"data_credentials_id": 0,
"source_type": "as400",
"source_config": {"start.cron": "0 0 22 10 11 ? 2022",
"db_query_mode": "Default",
"query": "string",
"database": "string",
"table": "string",
"mode": "none",
"incrementing.column.name": "string",
"incrementing.load.from": "string",
"timestamp.column.name": "string",
"timestamp.load.from": 0,
"commit.on.read": "false"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Delete a Source

Deletes a source from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

string

The unique ID of the source that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Get Source by ID with Expanded References

Returns a source object along with advanced information about associated references if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be fetched

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"sample_service_id": null,
"source_schema": {"properties": {"nexset_attribute_name1": "string",
"nexset_attribute_name2": "string"
},
"$schema": "string",
"$schema-id": 0
},
"transform": {"version": 0,
"data_maps": [ ],
"transforms": [ ],
"custom_config": { }
},
"output_schema": {"properties": {"nexset_attribute_name1": "string",
"nexset_attribute_name2": "string"
},
"$schema": "string",
"$schema-id": 0
}
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"property1": "string",
"property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Activate a Source

Activate a paused data source.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be activated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Pause a Source

Pause an active data source.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be paused.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Copy a Source

Use this endpoint to create a copy of an existing flow.

Authorizations:

NexlaSessionToken

path Parameters

source_id

required

integer

The unique ID of the source that needs to be copied.

Request Body schema: application/vnd.nexla.api.v1+json

reuse_data_credentials	boolean Set this to `true` if you do want to reuse the credentials of this source instead of creating a clone of the credentials also.
copy_access_controls	boolean Set this to `true` if you want the new source to be accessible by all users who have access to the this sink.
owner_id	integer The default API behavior is to create the new source in the account of the authenticated user making this call. Set this property if you want a different user to be the owner of the new source.
org_id	integer The default API behavior is to create the new source in the org that the authenticated user making this call belongs to. Set this property if you want the source to be created in a different org.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"reuse_data_credentials": true,
"copy_access_controls": true,
"owner_id": 0,
"org_id": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_sets": [{"version": 0,
"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"ingest_method": "string",
"source_format": "string",
"source_config": {"source_config_property1": "string",
"source_config_property2": "string"
},
"poll_schedule": null,
"managed": true,
"code_container_id": null,
"source_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"auto_generated": true,
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"run_ids": [{"id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Destinations (Data Sinks)

Operations for managing data sinks. Note that Destinations on the Nexla UI are aliased as data_sinks in the Nexla API reference model, so all endpoints and responses use the term data_sinks instead of destinations.

Get All Sinks

Retrieves all data sinks accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_set_id": 0,
"data_map_id": 0,
"data_source_id": null,
"sink_format": null,
"sink_schedule": null,
"in_memory": true,
"managed": true,
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"access_roles": ["owner"
],
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"data_set": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"data_map": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"public": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"tags": [ ],
"flow_type": "string",
"has_template": true,
"vendor_endpoint": {"id": 0,
"name": "string",
"display_name": "string"
},
"vendor": {"id": 0,
"name": "string",
"display_name": "string",
"connection_type": "string"
}
}
]

Create a Sink

Creates a Nexla data_sink with the specified configuration in your Nexla account.

Note: name ,data_set_id, sink_type, sink_config and data_credentials_id are required.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name

string

description

string

data_credentials_id

integer

Credential ID: Nexla data credential that contains all authentication information for this destination.

data_set_id

integer

Nexset ID: Set the Nexset ID whose output records will be written out to this destination.

sink_type

string

Connector Type: Connector codename.

as400

create_destination

boolean

Create Table In Destination If the desired table doesn't exist in your database, you can instruct Nexla to create a table when this destination is first activated.

Default Value: false

object

database	string Database: If the Destination credentials allow access to multiple databases, specify the database to which the destination table belongs. This is only needed if the `data_credentials` entry for this destination is not limited to one database.
table required	string Table: Set the table to which you wish to push Nexset records.
insert.mode required	string Enum: "INSERT" "UPSERT" Table Update Mode: Select whether records should be inserted or upserted into the database.
primary.key	string Primary Key Columns: Set all columns that should be set as primary keys of the table. For multiple columns, enter a comma-separated list of column names. Required if `insert.mode` is set to `UPSERT`
required	object Mapping: Set rules for how Nexset record attributes should be written into Database Columns.
upsert.nulls	boolean Allow column updates with nulls: Set as false to allow partial upserting of a record with only non-null values. Only valid if `insert.mode` is `UPSERT` Default Value: `true`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"sink_type": "as400",
"create_destination": true,
"sink_config": {"database": "string",
"table": "string",
"insert.mode": "INSERT",
"primary.key": "string",
"mapping": {"mode": "manual",
"mapping": {"nexset_attribute_name1": {"db_column_name1": "TINYINT",
"db_column_name2": "TINYINT"
},
"nexset_attribute_name2": {"db_column_name1": "TINYINT",
"db_column_name2": "TINYINT"
}
},
"tracker_mode": "NONE",
"tracker_name": "string"
},
"upsert.nulls": true
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Get Sink by ID

Returns a data_sink object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Update Sink

Updates a data_sink object in the authenticated user's account.

Note: This method does not perform partial updating of the sink_config object. The entire sink_config object will be updated if this is added to the payload.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

name

string

description

string

data_credentials_id

integer

Credential ID: Nexla data credential that contains all authentication information for this destination.

data_set_id

integer

Nexset ID: Set the Nexset ID whose output records will be written out to this destination.

sink_type

string

Connector Type: Connector codename.

as400

create_destination

boolean

Create Table In Destination If the desired table doesn't exist in your database, you can instruct Nexla to create a table when this destination is first activated.

Default Value: false

object

database	string Database: If the Destination credentials allow access to multiple databases, specify the database to which the destination table belongs. This is only needed if the `data_credentials` entry for this destination is not limited to one database.
table required	string Table: Set the table to which you wish to push Nexset records.
insert.mode required	string Enum: "INSERT" "UPSERT" Table Update Mode: Select whether records should be inserted or upserted into the database.
primary.key	string Primary Key Columns: Set all columns that should be set as primary keys of the table. For multiple columns, enter a comma-separated list of column names. Required if `insert.mode` is set to `UPSERT`
required	object Mapping: Set rules for how Nexset record attributes should be written into Database Columns.
upsert.nulls	boolean Allow column updates with nulls: Set as false to allow partial upserting of a record with only non-null values. Only valid if `insert.mode` is `UPSERT` Default Value: `true`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"sink_type": "as400",
"create_destination": true,
"sink_config": {"database": "string",
"table": "string",
"insert.mode": "INSERT",
"primary.key": "string",
"mapping": {"mode": "manual",
"mapping": {"nexset_attribute_name1": {"db_column_name1": "TINYINT",
"db_column_name2": "TINYINT"
},
"nexset_attribute_name2": {"db_column_name1": "TINYINT",
"db_column_name2": "TINYINT"
}
},
"tracker_mode": "NONE",
"tracker_name": "string"
},
"upsert.nulls": true
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Delete a Sink

Deletes a sink from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

string

The unique ID of the sink that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Get Sink by ID with Expanded References

Returns a data_sink object along with advanced information about associated references if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be fetched.

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string",
"description": "string",
"output_schema": {"properties": {"nexset_attribute_name1": "string",
"nexset_attribute_name2": "string"
},
"$schema": "string",
"$schema-id": 0
},
"status": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"version": 0
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Activate a Sink

Activate a paused data sink.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be activated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Pause a Sink

Pause an active data sink.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be paused.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Copy a Sink

Use this endpoint to create a copy of an existing data sink.

Authorizations:

NexlaSessionToken

path Parameters

sink_id

required

integer

The unique ID of the sink that needs to be copied.

Request Body schema: application/vnd.nexla.api.v1+json

reuse_data_credentials	boolean Set this to `true` if you do want to reuse the credentials of this sink instead of creating a clone of the credentials also.
copy_access_controls	boolean Set this to `true` if you want the new sink to be accessible by all users who have access to the this sink.
owner_id	integer The default API behavior is to create the new sink in the account of the authenticated user making this call. Set this property if you want a different user to be the owner of the new sink.
org_id	integer The default API behavior is to create the new sink in the org that the authenticated user making this call belongs to. Set this property if you want the sink to be created in a different org.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"reuse_data_credentials": true,
"copy_access_controls": true,
"owner_id": 0,
"org_id": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"name": "string",
"description": null,
"status": "string",
"data_set_id": 0,
"data_map_id": null,
"data_source_id": null,
"sink_format": null,
"sink_config": {"sink_config_property1": "string",
"sink_config_property2": "string"
},
"sink_schedule": null,
"in_memory": true,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"data_set": {"id": 0,
"name": "string"
},
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
},
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ],
"flow_type": "string"
}

Nexsets (Data Sets)

Operations for managing Nexsets. Note that Nexsets on the Nexla UI are aliased as data_sets in the Nexla API reference model, so all endpoints and responses use the term data_sets instead of nexsets.

Get All Nexsets

Retrieves all Nexsets accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}
]

Create a Nexset

Creates a Nexset from another Nexset.

The endpoint accepts a parent Nexset ID along with all transform and validation rules that should be applied to the parent Nexset.

The two payload variants reflect the following two ways of specifying transform rules:

Attach the transform code that should be applied: Set has_custom_transform: false, and attach a transform code snippet.
Use the ID of a reusable record transform: Set has_custom_transform: false, and attach the transform_id of the record transform to be applied.

Authorizations:

NexlaSessionToken

Request Body schema: application/vnd.nexla.api.v1+json

One of

has_custom_transform

required

boolean

Value: false

Set this to false to indicate that the payload contains the transform code that should be used for creating the output schema.

transform

object

Transform code that should be applied on the parent Nexset.

name

required

string

description

string

parent_data_set_id

required

integer

Nexset ID of the parent Nexset on which all the rules should be applied for creating this Nexset.

object

You can document details about important Nexset attributes by annotating them with short descriptions.

Set descriptions for all such attributes by adding them to this object. Attributes should be added in standard JSON schema path format. You can refer to Nexset's output schema structure for guidance.

object

additional property

object

description

string

Set a short description for this attribute.

output_schema_validation_enabled

boolean

Set this to true and attach the relevant output_validation_schema if you want all records to be validated against some JSON schema validation rules.

Records that fail validation will be routed to the Nexset error queue instead of the Nexset output.

object

You can set JSON Schema validation rules that should be applied on every record of this Nexset.

See https://json-schema.org/learn/getting-started-step-by-step.html for guidance on writing JSON schema validation rules.

json_schema_validation_rule*

additional property

object or string

Array of integers or objects

You can choose to attach one or more data sinks to this Nexset. Each data sink will receive the output of this Nexset when the Nexset generates output records.

Array

Any of

integer

The ID of the data sink.

custom_config

object

Reserved for Nexla UI: This field is used by Nexla UI for display instructions when displaying this Nexset on the UI. This entry has no impact on how the Nexla data plane processes data for this Nexset.

tags

Array of strings

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"has_custom_transform": true,
"transform_id": 0,
"name": "string",
"description": "string",
"parent_data_set_id": 0,
"output_schema_annotations": {"properties": {"nexset_attribute_name1": {"description": "string"
},
"nexset_attribute_name2": {"description": "string"
}
}
},
"output_schema_validation_enabled": true,
"output_validation_schema": {"json_schema_validation_rule1": { },
"json_schema_validation_rule2": { }
},
"data_sinks": [0
],
"custom_config": { },
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Get a Nexset

Returns a Nexset object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset that needs to be fetched.

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Update a Nexset

Updates a Nexset in the authenticated user's account.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset to be updated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/vnd.nexla.api.v1+json

One of

has_custom_transform

boolean

Value: false

Set this to false to indicate that the payload contains the transform code that should be used for creating the output schema.

transform

object

Transform code that should be applied on the parent Nexset.

name

string

description

string

parent_data_set_id

integer

Nexset ID of the parent Nexset on which all the rules should be applied for creating this Nexset.

object

You can document details about important Nexset attributes by annotating them with short descriptions.

Set descriptions for all such attributes by adding them to this object. Attributes should be added in standard JSON schema path format. You can refer to Nexset's output schema structure for guidance.

object

additional property

object

description

string

Set a short description for this attribute.

output_schema_validation_enabled

boolean

Set this to true and attach the relevant output_validation_schema if you want all records to be validated against some JSON schema validation rules.

Records that fail validation will be routed to the Nexset error queue instead of the Nexset output.

object

You can set JSON Schema validation rules that should be applied on every record of this Nexset.

See https://json-schema.org/learn/getting-started-step-by-step.html for guidance on writing JSON schema validation rules.

json_schema_validation_rule*

additional property

object or string

Array of integers or objects

You can choose to attach one or more data sinks to this Nexset. Each data sink will receive the output of this Nexset when the Nexset generates output records.

Array

Any of

integer

The ID of the data sink.

custom_config

object

Reserved for Nexla UI: This field is used by Nexla UI for display instructions when displaying this Nexset on the UI. This entry has no impact on how the Nexla data plane processes data for this Nexset.

tags

Array of strings

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"has_custom_transform": true,
"transform_id": 0,
"name": "string",
"description": "string",
"parent_data_set_id": 0,
"output_schema_annotations": {"properties": {"nexset_attribute_name1": {"description": "string"
},
"nexset_attribute_name2": {"description": "string"
}
}
},
"output_schema_validation_enabled": true,
"output_validation_schema": {"json_schema_validation_rule1": { },
"json_schema_validation_rule2": { }
},
"data_sinks": [0
],
"custom_config": { },
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Delete a Nexset

Deletes a Nexset from the authenticated user's account.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

string

The unique ID of the Nexset that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Activate Nexset

Activates a paused Nexset.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset that needs to be activated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Pause Nexset

Pauses an active Nexset.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset that needs to be paused.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Copy Nexset

Use this endpoint to create a clone of an existing Nexset.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset that needs to be copied.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/vnd.nexla.api.v1+json

copy_access_controls	boolean Set this to `true` if you want the new Nexset to be accessible by all users who have access to the this Nexset.
owner_id	integer The default API behavior is to create the new Nexset in the account of the authenticated user making this call. Set this property if you want a different user to be the owner of the new Nexset.
org_id	integer The default API behavior is to create the new Nexset in the org that the authenticated user making this call belongs to. Set this property if you want the Nexset to be created in a different org.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"copy_access_controls": true,
"owner_id": 0,
"org_id": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"data_source": {"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"status": "string",
"source_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"vendor_id": "string"
},
"parent_data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"status": "string",
"sink_type": "string"
}
],
"access_roles": ["owner"
],
"transform_id": 0,
"output_schema": { },
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"flow_type": "string"
}

Get Nexset Samples

Use this endpoint to fetch some sample records from this Nexset. Use the relevant query parameters to control whether the samples returned are from the live Nexset topic or the Nexset sample cache.

Authorizations:

NexlaSessionToken

path Parameters

set_id

required

integer

The unique ID of the Nexset that needs to be fetched.

query Parameters

count	integer The maximum number of samples that should be returned in the response.
include_metadata	boolean Set this to true to fetch Nexla metadata about each sample record along with the record content.
include_metadata	boolean Set this to true to fetch Nexla metadata about each sample record along with the record content.
live	boolean Set this to true to fetch live sample records from the Nexset topic.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[ ]

Credentials

Operations for managing data credentials.

Get All Credentials

Returns all data credentials accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"vendor": {"id": 0,
"name": "string",
"display_name": "string",
"connection_type": "string"
},
"template_config": { }
}
]

Create a Credential

Creates a Nexla data credential with the specified configuration in your Nexla account.

Note: name, credentials_type, and credentials are required.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name

string

description

string

credentials_type

string

as400

object

host required	string Host: Enter the hostname for your database. This is usually an IP address or text in the format company.domain.com. Do not include the connection protocol.
port required	integer Port: Enter the port used to access your database.
username required	string Username: Enter the username used to access your database.
password required	string Password: Enter the password used to access your database.
database_name	string Database Name: Enter the database name if you want to connect to a specific database.
has_ssh_tunnel	boolean Requires SSH Tunnel for access?: If your database is not publicly accessible, Nexla enables connecting via an SSH tunnel. When using this method, Nexla will connect to a bastion host via SSH, and the database connection will occur from the SSH host. Default value: `false`
tunnel.bastion.host	string SSH Tunnel Host: To connect via an SSH tunnel, you need to use a bastion host running an SSH tunnel server with access to your database. Enter the SSH tunnel hostname or IP address of the bastion host. Required if `has_ssh_tunnel` is `true`
tunnel.bastion.port	integer SSH Tunnel Port: Enter the port of the tunnel bastion host to which Nexla can connect. Required if `has_ssh_tunnel` is `true` Default Value: `22`
tunnel.bastion.user	string Username for tunnel: As part of setting up the bastion host, you also need to create an SSH user for Nexla. Enter that username here. Usually, this is set to `nexla`. Required if `has_ssh_tunnel` is `true`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"credentials_type": "as400",
"credentials": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"database_name": "string",
"has_ssh_tunnel": true,
"tunnel.bastion.host": "string",
"tunnel.bastion.port": 0,
"tunnel.bastion.user": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Get Credential by ID

Returns a credential object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Update Credential

Updates a data credential in the authenticated user's account.

Note: This method does not perform partial updating of the credentials object. The entire credentials object will be updated if this is added to the payload.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

name

string

description

string

credentials_type

string

as400

object

host required	string Host: Enter the hostname for your database. This is usually an IP address or text in the format company.domain.com. Do not include the connection protocol.
port required	integer Port: Enter the port used to access your database.
username required	string Username: Enter the username used to access your database.
password required	string Password: Enter the password used to access your database.
database_name	string Database Name: Enter the database name if you want to connect to a specific database.
has_ssh_tunnel	boolean Requires SSH Tunnel for access?: If your database is not publicly accessible, Nexla enables connecting via an SSH tunnel. When using this method, Nexla will connect to a bastion host via SSH, and the database connection will occur from the SSH host. Default value: `false`
tunnel.bastion.host	string SSH Tunnel Host: To connect via an SSH tunnel, you need to use a bastion host running an SSH tunnel server with access to your database. Enter the SSH tunnel hostname or IP address of the bastion host. Required if `has_ssh_tunnel` is `true`
tunnel.bastion.port	integer SSH Tunnel Port: Enter the port of the tunnel bastion host to which Nexla can connect. Required if `has_ssh_tunnel` is `true` Default Value: `22`
tunnel.bastion.user	string Username for tunnel: As part of setting up the bastion host, you also need to create an SSH user for Nexla. Enter that username here. Usually, this is set to `nexla`. Required if `has_ssh_tunnel` is `true`

Responses

Request samples

Payload

Content type

application/json

Example

as400

{"name": "string",
"description": "string",
"credentials_type": "as400",
"credentials": {"host": "string",
"port": 0,
"username": "string",
"password": "string",
"database_name": "string",
"has_ssh_tunnel": true,
"tunnel.bastion.host": "string",
"tunnel.bastion.port": 0,
"tunnel.bastion.user": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Delete a Credential

Deletes a credential from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

string

The unique ID of the credential that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Get Credential by ID with expanded references

Returns a credential object along with advanced information about associated references if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential that needs to be fetched

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
},
"access_roles": ["owner"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}

Test credential validity

Use this endpoint to check whether or not a credential is valid.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential being used.

Responses

Response samples

403

Content type

application/json

{"status": 403,
"message": "string"
}

Preview Storage Structure

Use this endpoint to preview the structure/hierarchy of storage to which this credential grants access. For example, you can use this endpoint to see the folder and file structure of a file storage system or the table-column structure of a database. This can be used to inspect the directory hierarchy of file content storage or the database schema of a database/warehouse storage system. Note that this endpoint is only valid for credentials for storage systems wherein a storage structure needs to be reviewed.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential being used.

Request Body schema: application/json

One of

depth

required

integer

Specify the hierarchy depth that should be scanned and returned in the response.

If no other payload properties are provided, the depth is relative to the storage root. If this request contains instructions about the slice of storage to be previewed (using the path/database/table properties), the depth will be applied relative to that storage slice.

We recommend using a depth = 1 to ensure that only small, relevant slices of the storage system are scanned.

path

string

Folder or subfolder path for which you wish to retrieve the content structure. The path string should be structured from the root of the location to the credential. For example, demo-out.nexla.com/users/test will return the folder tree for the contents of the test subfolder.

This is relevant for file-type connectors.

Responses

Request samples

Payload

Content type

application/json

{"depth": 0,
"database": "string",
"table": "string"
}

Response samples

200

Content type

application/json

Example

azure_blb

{"status": "ok",
"message": "Ok",
"connection_type": "azure_blb",
"object": {"folder_name": {"type": "folder",
"display_name": "string",
"value": {"file_name": {"type": "file",
"created_at": 0,
"updated_at": 0,
"size": 0,
"display_name": "string"
}
}
},
"meta": {"type": "meta",
"value": { }
}
}
}

Preview Connector Content

Use this endpoint to preview the data content in a storage system.

For file systems, this can be used to preview the file content of any specific file.
For database systems, it can be used to preview sample rows from a table or query result.
For the rest connector, it can be used to preview the results of any API request.
For streaming connectors, it can be used to preview some records in a topic.

For most connectors, it can also be used to determine the type of records that might be detected in the resulting Nexset.

Authorizations:

NexlaSessionToken

path Parameters

credential_id

required

integer

The unique ID of the credential being used.

Request Body schema: application/json

One of

path	string For file type connectors: Set the path to the file from which you wish to preview content.

Responses

Request samples

Payload

Content type

application/json

{"connector_source_config_property1": "string",
"connector_source_config_property2": "string"
}

Response samples

200

Content type

application/json

{"status": "ok",
"message": "Ok",
"connection_type": "soap",
"output": {"contentType": "string",
"statusCode": 0,
"response": "string"
}
}

Data Maps

Get all Data Maps

Retrieves all lookups (data maps) accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"public": true,
"managed": true,
"data_type": "string",
"data_format": "string",
"data_sink_id": "string",
"emit_data_default": true,
"use_versioning": true,
"map_primary_key": "id",
"data_defaults": { },
"updated_at": "2021-07-26T21:29:58.000Z",
"created_at": "2021-07-26T21:29:58.000Z",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_set_id": 0,
"map_entry_count": 200,
"map_entry_schema": { },
"tags": ["string"
]
}
]

Create a Static Data Map

Creates a new static data map in the authenticated user's account. Dynamic data maps can only be created by creating a Destination (Sink) of the type data_map.

For statically assigned data maps, you can choose to add data rows to the data map by either of the following methods:

Send data map entries with this request. In this case, the rows of data are sent as a data_map array of objects.
Send data map entries as a separate call to add/update entries.

You must include map_primary_key to specify which map attribute should be used for data matching.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name

required

string

description

string

map_primary_key

string

Key name which should be used as the primary key for looking up rows in this data map.

object

The default values to use for any key if the key is not present in the corresponding row.

data_map_key*

additional property

string or number

Enter the data map key and corresponding default value you wish to be assigned to that key.

emit_data_default

boolean

This property defines whether a lookup query should return values with applicable default values for missing properties in the row.

tags

Array of strings

Array of objects

Enter an array of data map entries if you wish to seed this data map with some rows of data while creating the data map.

You can also update data map rows by calling the endpoint for updating entries.

Array

data_map_key*

additional property

string or number

Each property in this object should be keyed by the desired key name and the value should be equal to the desired value of that key.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"map_primary_key": "id",
"data_defaults": {"data_map_key1": "string",
"data_map_key2": "string"
},
"emit_data_default": true,
"tags": ["string"
],
"data_map": [{"data_map_key1": "string",
"data_map_key2": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"public": true,
"managed": true,
"data_type": "string",
"data_format": "string",
"data_sink_id": "string",
"emit_data_default": true,
"use_versioning": true,
"map_primary_key": "id",
"data_defaults": { },
"updated_at": "2021-07-26T21:29:58.000Z",
"created_at": "2021-07-26T21:29:58.000Z",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_set_id": 0,
"map_entry_count": 200,
"map_entry_schema": { },
"tags": ["string"
]
}

Get Data Map by ID

Retrieves a data map object if a valid ID is provided.

This call to /data_maps does not return data map entries, as they can be a large array of objects for big data maps.

You can include the expand query parameter to fetch the data map entries of smaller static data maps.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map that needs to be fetched.

query Parameters

expand

integer

Value: 1

Add this parameter to a resource fetch request to receive details about related resources in the response.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"public": true,
"managed": true,
"data_type": "string",
"data_format": "string",
"data_sink_id": "string",
"emit_data_default": true,
"use_versioning": true,
"map_primary_key": "id",
"data_defaults": { },
"updated_at": "2021-07-26T21:29:58.000Z",
"created_at": "2021-07-26T21:29:58.000Z",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_set_id": 0,
"map_entry_count": 200,
"map_entry_schema": { },
"tags": ["string"
]
}

Update Data Map Metadata

Updates a data map in the authenticated user's account.

This endpoint is suitable for updating the metadata of a data map. We recommend using the data map entries update and delete endpoints to update data map rows.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map that needs to be updated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

name

string

description

string

map_primary_key

string

Key name which should be used as the primary key for looking up rows in this data map.

object

The default values to use for any key if the key is not present in the corresponding row.

data_map_key*

additional property

string or number

Enter the data map key and corresponding default value you wish to be assigned to that key.

emit_data_default

boolean

This property defines whether a lookup query should return values with applicable default values for missing properties in the row.

tags

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"map_primary_key": "id",
"data_defaults": {"data_map_key1": "string",
"data_map_key2": "string"
},
"emit_data_default": true,
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"public": true,
"managed": true,
"data_type": "string",
"data_format": "string",
"data_sink_id": "string",
"emit_data_default": true,
"use_versioning": true,
"map_primary_key": "id",
"data_defaults": { },
"updated_at": "2021-07-26T21:29:58.000Z",
"created_at": "2021-07-26T21:29:58.000Z",
"owner": {"id": 0,
"full_name": "string",
"email": "user@example.com"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_set_id": 0,
"map_entry_count": 200,
"map_entry_schema": { },
"tags": ["string"
]
}

Delete a Data Map

Deletes a data map from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Upsert Static Data Map Entries

Updates the entries in a static data map. Use this endpoint to add new entries or update the row corresponding to a specific key.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map that needs to be updated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

Array of objects

Enter the array of data map entries that you wish to upsert. This call will result in an upsert on the data map, i.e., new rows will be added for keys not present in the data map, and relevant rows will be updated for keys that are already present.

Array

data_map_key*

additional property

string or number

Each property in this object should be keyed by the desired key name, and the value should be equal to the desired value of that key.

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"OrderNo": "1002",
"Price": "40.38",
"key": "1002_4",
"ItemNo": "4",
"Qty": "10000"
}
]
}

Response samples

200

Content type

application/json

[{"data_map_entry1": "string",
"data_map_entry2": "string"
}
]

Check Data Map Entries

Returns the rows of data from the data map that matches a desired key or key pattern.

This endpoint can be used to check whether the data map contains rows of data that match the desired key, keys, or key patterns. Key names should be provided in the path in the format described below.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id required	integer The unique ID of the data map that needs to be fetched.
entry_keys required	string or integer One or more comma-separated keys for accessing data map entries. These keys may contain simple matching expressions with `*` wildcard characters. The response will contain entries whose primary key values match the pattern.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"data_map_entry1": "string",
"data_map_entry2": "string"
}
]

Delete Data Map Entries

Deletes specific entries from the data map.

Use this endpoint to remove specific entries from the data map.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id required	integer The unique ID of the data map that needs to be fetched.
entry_keys required	string or integer One or more comma-separated keys for accessing access data map entries. These keys may contain simple matching expressions with `*` wildcard characters.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Transforms

Operations for managing reusable attribute and record transforms.

Get all Reusable Record Transforms

Reusable record transforms are reusable code blocks that can be used to modify an input record of a Nexset into an output record of that Nexset. Use this endpoint to fetch all reusable record transforms.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{ }
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}
]

Create a Reusable Record Transform

Create a new reusable record transform.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name

required

string

description

string

output_type

required

string

Value: "record"

Type of code container. This must be set to record to signify that this code container is to be used to convert an input record of a Nexset into an output record for that Nexset.

reusable

required

boolean

Whether or not this transform can be referenced by multiple Nexsets. This should always be true for reusable record transforms.

code_type

required

string

Enum: "jolt_custom" "jolt_standard"

Type of code in the code block. Use jolt_custom if the code in the code block is a python or javascript transform code block wrapped inside a Jolt operation block.

code_encoding

required

string

Value: "none"

Whether or not the code in the code block is encoded. Set this to none for reusable record transforms.

required

Array of objects or Array of objects

Code to be executed for transforming records. If you wish to execute a Python or Javascript code snippet during transformation, you'll need to base64-encode that code snippet and wrap it inside the following Jolt operation object.

For example, if you want to execute this Python code as a reusable record transform

def transform(input, metadata, args):
  # Sample python transform to pass all attributes through
return input

the corresponding code object would be

[
  {
    "operation": "nexla.custom",
    "spec": {
      "language": "python",
      "encoding": "base64",
      "script": "ZGVmIHRyYW5zZm9ybShpbnB1dCwgbWV0YWRhdGEsIGFyZ3MpOgogICMgU2FtcGxlIHB5dGhvbiB0cmFuc2Zvcm0gdG8gcGFzcyBhbGwgYXR0cmlidXRlcyB0aHJvdWdoCiAgcmV0dXJuIGlucHV0"
    }
  }
]

One of

Array

operation	string Value: "nexla.custom" Jolt operation for this code block. For `python` and `javascript`, it must be `nexla.custom`.
	object Jolt specification for this block. See the Python example above for sample specs.

custom_config

object

Configuration block useful for converting code into Nexla UI's Nexset Designer Rule blocks.

This should not be sent in the payload unless the transform is being created using the Nexla UI's Nexset Designer screen.

tags

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"output_type": "record",
"reusable": true,
"code_type": "jolt_custom",
"code_encoding": "none",
"code": [{"operation": "nexla.custom",
"spec": {"language": "python",
"encoding": "base64",
"script": "string"
}
}
],
"custom_config": { },
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{ }
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Get A Reusable Record Transform

Returns a reusable record transform object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

transform_id

required

integer

The unique ID of the transform that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{ }
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Update Reusable Record Transform

Updates a transform in the authenticated user's account.

Authorizations:

NexlaSessionToken

path Parameters

transform_id

required

integer

The unique ID of the transform that needs to be updated.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

name required	string
description	string
data_credentials_id	integer <nullable> Credential ID for accessing the code repository (e.g., Github). This is for code containers in which the code is saved in a remote repository. Note that this is not required for script connectors in which the script is hosted in a Nexla Github repository.
runtime_data_credentials_id	integer <nullable> Note: This is an alpha property that is likely to be deprecated/replaced in a future release. Credential ID for the file store. This is required code blocks used for parsing files.
output_type required	string Enum: "record" "attribute"
code_type required	string Enum: "jolt_standard" "jolt_custom" "python" "javascript"
code_encoding required	string Enum: "none" "base64" Whether or not the code in the `code` block is encoded. Set this to `none` for reusable record transforms.
required	string or Array of objects Code to be executed in this code container. Please refer to the endpoints for `transforms`, `attribute_transforms` and `validators` for respective `code` block requirements.
One of string Code to be executed in this code container. Please refer to the endpoints for `transforms`, `attribute_transforms` and `validators` for respective `code` block requirements.
reusable required	boolean Whether or not this transform can be referenced by multiple resources. This should always be `true` for reusable record and attribute transforms.
tags	Array of strings
custom_config	object

Responses

Request samples

Payload

Content type

application/json

{"name": "test",
"description": "test",
"data_credentials_id": 0,
"runtime_data_credentials_id": 0,
"output_type": "record",
"code_type": "jolt_standard",
"code_encoding": "none",
"code": "string",
"reusable": true,
"tags": ["string"
],
"custom_config": { }
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "source",
"reusable": true,
"public": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{"operation": "nexla.custom",
"spec": {"language": "python",
"encoding": "base64",
"script": "ZGVmIHRyYW5zZm9ybShpbnB1dCwgbWV0YWRhdGEsIGFyZ3MpOgogICMgU2FtcGxlIHB5dGhvbiB0cmFuc2Zvcm0gdG8gcGFzcyBhbGwgYXR0cmlidXRlcyB0aHJvdWdoCiAgcmV0dXJuIGlucHV0"
}
}
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2023-01-24T03:26:43.000Z",
"created_at": "2023-01-24T03:26:43.000Z",
"tags": ["string"
]
}

Delete a Reusable Record Transform

Use this endpoint to delete a reusable record transform.

Authorizations:

NexlaSessionToken

path Parameters

transform_id

required

integer

The unique ID of the transform that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Copy a Reusable Record Transform

Use this endpoint to create a copy of an existing reusable record transform.

Authorizations:

NexlaSessionToken

path Parameters

transform_id

required

integer

The unique ID of the transform to be copied.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{ }
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Get all Public Reusable Record Transforms

The Nexla team regularly adds common reusable record transforms that are made available to all Nexla accounts.

Use this endpoint to fetch all such "publicly" available reusable record transforms.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "jolt_standard",
"output_type": "record",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": [{ }
],
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}
]

Get all Attribute Transforms

Reusable attribute transforms are reusable code blocks that can be used to define the value of an output attribute in a Nexset. These code blocks can be used to enhance the set of transforms available to end users when using the Nexset Designer.

Use this endpoint to fetch all attribute transforms accessible to the authenticated user.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "python",
"output_type": "attribute",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": "string",
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}
]

Create an Attribute Transform

Create a new attribute transform.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

name required	string
description	string
output_type required	string Value: "attribute" Type of code container. This must be set to `attribute` to signify that this code container is to be used for generating the value of an output attribute.
reusable required	boolean Whether or not this transform can be referenced by multiple Nexsets. This should always be `true` for reusable transforms.
code_type required	string Enum: "python" "javascipt" Type of code in the code block.
code_encoding required	string Value: "base64" Whether or not the code in the `code` block is encoded. Set this to `base64` for reusable attribute transforms.
code required	string Code to be executed for transforming records. If you wish to execute a Python or Javascript code snippet during transformation, you'll need to `base64`-encode that code snippet. For example, if you want to execute this Python code as a reusable record transform `def transformAttribute(input, metadata, args): return input.get(args[0])` the corresponding `code` value would be `ZGVmIHRyYW5zZm9ybUF0dHJpYnV0ZShpbnB1dCwgbWV0YWRhdGEsIGFyZ3MpOgogIHJldHVybiBpbnB1dC5nZXQoYXJnc1swXSk=`
custom_config	object Configuration block useful for converting code into Nexla UI's Nexset Designer Rule blocks. This should not be sent in the payload unless the transform is being created using the Nexla UI's Nexset Designer screen.
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"output_type": "attribute",
"reusable": true,
"code_type": "python",
"code_encoding": "base64",
"code": "string",
"custom_config": { },
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "python",
"output_type": "attribute",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": "string",
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Get Attribute Transform by ID

Returns an attribute transform object if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

attribute_transform_id

required

integer

The unique ID of the attribute transform that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "python",
"output_type": "attribute",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": "string",
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Update Attribute Transform

Updates an attribute transform in the authenticated user's account.

Authorizations:

NexlaSessionToken

path Parameters

attribute_transform_id

required

integer

The unique ID of the attribute transform.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/json

name required	string
description	string
output_type required	string Value: "attribute" Type of code container. This must be set to `attribute` to signify that this code container is to be used for generating the value of an output attribute.
reusable required	boolean Whether or not this transform can be referenced by multiple Nexsets. This should always be `true` for reusable transforms.
code_type required	string Enum: "python" "javascipt" Type of code in the code block.
code_encoding required	string Value: "base64" Whether or not the code in the `code` block is encoded. Set this to `base64` for reusable attribute transforms.
code required	string Code to be executed for transforming records. If you wish to execute a Python or Javascript code snippet during transformation, you'll need to `base64`-encode that code snippet. For example, if you want to execute this Python code as a reusable record transform `def transformAttribute(input, metadata, args): return input.get(args[0])` the corresponding `code` value would be `ZGVmIHRyYW5zZm9ybUF0dHJpYnV0ZShpbnB1dCwgbWV0YWRhdGEsIGFyZ3MpOgogIHJldHVybiBpbnB1dC5nZXQoYXJnc1swXSk=`
custom_config	object Configuration block useful for converting code into Nexla UI's Nexset Designer Rule blocks. This should not be sent in the payload unless the transform is being created using the Nexla UI's Nexset Designer screen.
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"output_type": "attribute",
"reusable": true,
"code_type": "python",
"code_encoding": "base64",
"code": "string",
"custom_config": { },
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "python",
"output_type": "attribute",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": "string",
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Delete an Attribute Transform

Deletes an attribute transform from your Nexla account.

Authorizations:

NexlaSessionToken

path Parameters

attribute_transform_id

required

integer

The unique ID of the attribute transform that needs to be deleted.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Get all Public Attribute Transforms

The Nexla team regularly adds common reusable attribute transforms that are made available to all Nexla accounts.

Use this endpoint to fetch all such "publicly" available reusable attribute transforms.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "test",
"resource_type": "transform",
"reusable": true,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"runtime_data_credentials": {"id": 0,
"name": "string",
"description": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"description": "test",
"code_type": "python",
"output_type": "attribute",
"code_config": { },
"custom_config": { },
"code_encoding": "none",
"code": "string",
"managed": true,
"data_sets": [0
],
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}
]

Projects

Operations for managing projects.

Get all Projects

Retrieves a list of all projects accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"owner": {"id": 0,
"full_name": "John Johnson",
"email": "example@nexla.com"
},
"org": {"id": 0,
"name": "Nexla",
"email_domain": "nexla.com",
"client_identifier": "string"
},
"name": "test project",
"description": "it's a test project",
"data_flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"access_roles": ["owner"
],
"tags": ["string"
],
"copied_from_id": "string",
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
]

Create a project

Creates a project with the specified configuration. Note that flows can also be attached to the project later by calling endpoints to update the project.

Authorizations:

NexlaSessionToken

Request Body schema: application/vnd.nexla.api.v1+json

name

required

string

description

string

Array of objects or objects

Array

Any of

data_source_id

integer

The ID of the data source which is the root node of this flow chain.

Unless the flow chain has been created from a shared Nexset, flow definitions start from the source as the root node. This property reflects the source that is the root node of this flow.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"name": "test project",
"description": "it's a test project",
"data_flows": [{"data_source_id": 0
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "John Johnson",
"email": "example@nexla.com"
},
"org": {"id": 0,
"name": "Nexla",
"email_domain": "nexla.com",
"client_identifier": "string"
},
"name": "test project",
"description": "it's a test project",
"data_flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"access_roles": ["owner"
],
"tags": ["string"
],
"copied_from_id": "string",
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}

Get Project by ID

Returns a project if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "John Johnson",
"email": "example@nexla.com"
},
"org": {"id": 0,
"name": "Nexla",
"email_domain": "nexla.com",
"client_identifier": "string"
},
"name": "test project",
"description": "it's a test project",
"data_flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"access_roles": ["owner"
],
"tags": ["string"
],
"copied_from_id": "string",
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}

Delete Project by ID

Deletes a project if a valid ID is provided. Note that flows belonging to the project will only be removed from the project and will not be deleted.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Responses

Modify a Project

Modifies a project's information and settings if a valid ID and body are provided.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

name

string

description

string

Array of objects or objects

Array

Any of

data_source_id

integer

The ID of the data source which is the root node of this flow chain.

Unless the flow chain has been created from a shared Nexset, flow definitions start from the source as the root node. This property reflects the source that is the root node of this flow.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"name": "test project",
"description": "it's a test project",
"data_flows": [{"data_source_id": 0
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "John Johnson",
"email": "example@nexla.com"
},
"org": {"id": 0,
"name": "Nexla",
"email_domain": "nexla.com",
"client_identifier": "string"
},
"name": "test project",
"description": "it's a test project",
"data_flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"flows": [{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
],
"access_roles": ["owner"
],
"tags": ["string"
],
"copied_from_id": "string",
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}

Get Project Flows

Returns a list of flows belonging to a project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Responses

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Replace Project Flows List

Replaces the list of flows belonging to a project. Existing flows are removed from the project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

flows

Array of integers

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"flows": [0
]
}

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Add Flows to Project

Adds a list of flows to a project. The existing flow list is retained and merged with the new flow list.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

flows

Array of integers

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"flows": [0
]
}

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Remove Flows From A Project

Removes data flows from a project. If no request body is provided, all flows belonging to the project will be removed. The flows themselves will not be deleted, but they will no longer belong to the project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of flow identifiers. Data flows must be referenced by the resource associated with them in the GET response.

flows

Array of integers

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"flows": [0
]
}

Response samples

200

Content type

application/json

{"flows": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"shared_origin_node_id": 0,
"status": "string",
"project_id": 0,
"flow_type": "string",
"ingestion_mode": "string",
"name": "string",
"description": "string",
"children": [{"id": 0,
"parent_node_id": 0,
"origin_node_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"data_sink_id": 0,
"children": [ ]
}
]
}
],
"code_containers": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"data_credentials_id": null,
"public": true,
"managed": true,
"reusable": true,
"resource_type": "string",
"output_type": "string",
"code_type": "string",
"code_encoding": "string",
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sources": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_sink_id": 0,
"auto_generated": true,
"managed": true,
"source_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sets": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": "string",
"status": "string",
"data_source_id": 0,
"parent_data_set_id": 0,
"code_container_id": 0,
"data_sink_ids": [ ],
"public": true,
"managed": true,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_sinks": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"flow_node_id": 0,
"origin_node_id": 0,
"name": "string",
"description": null,
"status": "string",
"data_credentials_id": 0,
"data_set_id": 0,
"data_source_id": 0,
"managed": true,
"sink_type": "string",
"connector_type": "string",
"connection_type": "string",
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"data_credentials": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": null,
"credentials_type": "string",
"verified_status": "string",
"managed": true,
"template_config": { },
"vendor": null,
"access_roles": [ ],
"tags": [ ],
"copied_from_id": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shared_data_sets": [ ],
"orgs": [{"id": 0,
"name": "string",
"email_domain": "string",
"email": null,
"client_identifier": null
}
],
"users": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"projects": [{"id": 0,
"owner_id": 0,
"org_id": 0,
"name": "string",
"description": "string",
"access_roles": [ ]
}
]
}

Get Project Flows (Deprecated)

Returns a list of flows belonging to a project.

Note: This version of the endpoint has been deprecated. The returned flow response does not reference the new unique flow ids, instead references composite data flow ids of the type {resource_type}/{resource_id}. See get_project_flows for a new version of this endpoint that references unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
]

Replace Project Flows List (Deprecated)

Replaces the list of flows belonging to a project. Existing flows are removed from the project.

Note: This version of the endpoint has been deprecated. The request body and response does not reference flows with new unique flow_ids, instead references composite data flow ids of the type {resource_type}/{resource_id}. See replace_project_flows for a new version of this endpoint that references unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects

Array

Any of

data_source_id

integer

The ID of the data source which is the root node of this flow chain.

Unless the flow chain has been created from a shared Nexset, flow definitions start from the source as the root node. This property reflects the source that is the root node of this flow.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"data_flows": [{"data_source_id": 0
}
]
}

Response samples

200

Content type

application/json

[{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
]

Add Flows to Project (Deprecated)

Adds a list of flows to a project. The existing flow list is retained and merged with the new flow list.

Note: This version of the endpoint has been deprecated. The request body and response does not reference flows with new unique flow_ids, instead references composite data flow ids of the type {resource_type}/{resource_id}. See add_project_flows for a new version of this endpoint that references unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects

Array

Any of

data_source_id

integer

The ID of the data source which is the root node of this flow chain.

Unless the flow chain has been created from a shared Nexset, flow definitions start from the source as the root node. This property reflects the source that is the root node of this flow.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"data_flows": [{"data_source_id": 0
}
]
}

Response samples

200

Content type

application/json

[{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
]

Remove Flows From A Project (Deprecated)

Removes data flows from a project. If no request body is provided, all flows belonging to the project will be removed. The flows themselves will not be deleted, but they will no longer belong to the project.

Note: This version of the endpoint has been deprecated. The request body and response does not reference flows with new unique flow_ids, instead references composite data flow ids of the type {resource_type}/{resource_id}. See remove_project_flows for a new version of this endpoint that references unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of flow identifiers. Data flows must be referenced by the resource associated with them in the GET response.

Array of objects or objects

Array

Any of

data_source_id

integer

The ID of the data source which is the root node of this flow chain.

Unless the flow chain has been created from a shared Nexset, flow definitions start from the source as the root node. This property reflects the source that is the root node of this flow.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"data_flows": [{"data_source_id": 0
}
]
}

Response samples

200

Content type

application/json

[{"id": 0,
"project_id": 0,
"data_source_id": 0,
"data_set_id": 0,
"updated_at": "2023-01-31T01:39:54.000Z",
"created_at": "2023-01-31T01:39:54.000Z"
}
]

Notifications

Operations for managing notifications.

Get All Notifications

Returns all notifications in the authenticated user's account. Note that this only includes notifications generated to be displayed in the Nexla UI.

Authorizations:

NexlaSessionToken

path Parameters

read	integer Set the read query parameter to 0 to fetch only notifications that have not yet been read, or set it to 1 to fetch only those that have been read.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"level": "string",
"resource_id": 0,
"resource_type": "string",
"message_id": 0,
"message": "string",
"read_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]

Get a Notification

Returns a notification if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_id

required

integer

The unique ID of the notification.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["owner"
],
"level": "string",
"resource_id": 0,
"resource_type": "string",
"message_id": 0,
"message": "string",
"read_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Delete a Notification

Deletes a notification if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_id

required

integer

The unique ID of the notification.

Responses

Delete All Notifications

Deletes all notifications belonging to the authenticated user. Note that this is only the list of notifications generated to be displayed in the Nexla UI.

Authorizations:

NexlaSessionToken

Responses

Get Notifications Count

Returns the total number of notifications in the authenticated user's account. Note that this only includes notifications generated to be displayed in the Nexla UI.

Authorizations:

NexlaSessionToken

path Parameters

read	integer Set the read query parameter to 0 to fetch only notifications that have not yet been read, or set it to 1 to fetch only those that have been read. If you don't send a read query parameter, all notifications (both read and unread) will be fetched.

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Mark Notification Read

Use this endpoint to mark one, multiple, or all notifications as read. To mark a list of notifications, send an array of notification IDs as the payload. To mark all notifications, send the notification_id query parameter with the value all.

Authorizations:

NexlaSessionToken

query Parameters

string or integer

The unique ID of one or more notifications, or enter "all" to mark all notifications as read. This can be used in place of an array of IDs in the request body.

Request Body schema: application/json

Array

integer

Responses

Request samples

Payload

Content type

application/json

[0
]

Mark Notification Unread

Use this endpoint to mark one, multiple, or all notifications as read. To mark a list of notifications, send an array of notification IDs as the payload. To mark all notifications, send the notification_id query parameter with the value all.

Authorizations:

NexlaSessionToken

query Parameters

string or integer

The unique ID of one or more notifications, or enter "all" to mark all notifications as unread. This can be used in place of an array of IDs in the request body.

Request Body schema: application/json

Array

integer

Responses

Request samples

Payload

Content type

application/json

[0
]

Get All Notification Types

Fetches a list of all notifications supported by Nexla in this environment.

When users choose whether or not some notifications are enabled, their choices are saved in notification_settings and linked to the ID of the relevant notification type.

Authorizations:

NexlaSessionToken

query Parameters

status

string

Enum: "ACTIVE" "PAUSE"

The status field indicates whether the environment is configured to generate these notifications. Usually, all notifications will be in the ACTIVE state.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"category": "PLATFORM",
"default": true,
"status": true,
"event_type": "SHARE",
"resource_type": "ORG"
}
]

Get One Notification Type

Fetches details about a specific notification type supported by Nexla in this environment.

Authorizations:

NexlaSessionToken

query Parameters

event_type required	string Enum: "SHARE" "CREATE" "DELETE" "UPDATE" "ACTIVATE" "PAUSE" "METRICS" "RESETPASS" "ERROR_AGGREGATED" "ERROR" "MONITOR" "WRITE" "EMPTY_DATA" "READ_START" "READ_DONE" "WRITE_START" "WRITE_DONE"
resource_type required	string Enum: "ORG" "USER" "DATA_FLOW" "CUSTOM_DATA_FLOW" "SOURCE" "DATASET" "SINK"

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"category": "PLATFORM",
"default": true,
"status": true,
"event_type": "SHARE",
"resource_type": "ORG"
}

List Notification Channel Settings

Notification channel settings contain configuration settings relevant to where notifications should be delivered. For example, the settings for the EMAIL channel contain the email addresses to which notifications can be sent.

You can maintain multiple configuration settings for the same channel to route notifications for specific resources and types to different locations.

This endpoint lists all notification channel settings in the authenticated user's account.

Authorizations:

NexlaSessionToken

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"owner_id": 0,
"org_id": 0,
"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}
]

Create a Notification Channel Setting

Create a new configuration for a notification channel.

You can maintain multiple configuration settings for the same channel to route notifications for specific resources and types to different locations.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

channel

required

string

Enum: "APP" "EMAIL" "SMS" "SLACK" "WEBHOOKS"

required

object

config_property*

additional property

string

Set the relevant configuration properties based on the type of notification channel.

Responses

Request samples

Payload

Content type

application/json

{"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner_id": 0,
"org_id": 0,
"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}

Get a Notification Channel Setting

Returns a notification channel setting if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_channel_setting_id

required

integer

The unique ID of the notification channel setting.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner_id": 0,
"org_id": 0,
"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}

Update a Notification Channel Setting

Update the configuration of a notification channel setting.

Authorizations:

NexlaSessionToken

path Parameters

notification_channel_setting_id

required

integer

The unique ID of the notification channel setting.

Request Body schema: application/json

channel

string

Enum: "APP" "EMAIL" "SMS" "SLACK" "WEBHOOKS"

object

config_property*

additional property

string

Set the relevant configuration properties based on the type of notification channel.

Responses

Request samples

Payload

Content type

application/json

{"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner_id": 0,
"org_id": 0,
"channel": "APP",
"config": {"config_property1": "string",
"config_property2": "string"
}
}

Delete a Notification Channel Setting

Deletes a notification channel setting if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_channel_setting_id

required

integer

The unique ID of the notification channel setting.

Responses

List Notification Settings

This endpoint lists all notification settings in the authenticated user's account.

Notification settings contain the following user settings:

Whether the user wants to be notified about a specific event (status of a notification_type on a notification_resource_type)
If yes, on what channel the user wants to be notified
The configuration of the channel (notification_channel_setting_id)
Configuration parameters affect when the notification should be fired. This is usually left empty to use platform defaults, but it is relevant when users want to override the default settings of some notifications, such as Source Data Delayed

Authorizations:

NexlaSessionToken

query Parameters

event_type	string Enum: "SHARE" "CREATE" "DELETE" "UPDATE" "ACTIVATE" "PAUSE" "METRICS" "RESETPASS" "ERROR_AGGREGATED" "ERROR" "MONITOR" "WRITE" "EMPTY_DATA" "READ_START" "READ_DONE" "WRITE_START" "WRITE_DONE"
resource_type	string Enum: "ORG" "USER" "DATA_FLOW" "CUSTOM_DATA_FLOW" "SOURCE" "DATASET" "SINK"
status	string Enum: "PAUSED" "ACTIVE" Whether or not the user should be notified about this event for this resource on the selected channel.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"notification_resource_type": "ORG",
"resource_id": 0,
"config": { },
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"name": "string",
"description": "string",
"code": 0,
"category": "string",
"event_type": "SHARE",
"resource_type": "ORG"
}
]

Create a Notification Setting

Create a setting to designate whether, when, and how a specific notification should be fired.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

channel

required

string

Enum: "APP" "EMAIL" "SMS" "SLACK" "WEBHOOKS"

status

string

Enum: "PAUSED" "ACTIVE"

Whether or not the user should be notified about this event for this resource on the selected channel.

object

Configuration properties for customizing the criteria for firing the event.

config_property*

additional property

string

Set the relevant configuration properties if you want to override the default platform settings.

notification_resource_type

string

Enum: "ORG" "USER" "DATA_FLOW" "CUSTOM_DATA_FLOW" "SOURCE" "DATASET" "SINK"

resource_id

integer

checked

boolean

notification_channel_setting_id

integer

notification_type_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"channel": "APP",
"status": "PAUSED",
"config": {"config_property1": "string",
"config_property2": "string"
},
"notification_resource_type": "ORG",
"resource_id": 0,
"checked": true,
"notification_channel_setting_id": 0,
"notification_type_id": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"notification_resource_type": "ORG",
"resource_id": 0,
"config": { },
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"name": "string",
"description": "string",
"code": 0,
"category": "string",
"event_type": "SHARE",
"resource_type": "ORG"
}

Get a Notification Setting

Returns a notification if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_setting_id

required

integer

The unique ID of the notification setting.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"notification_resource_type": "ORG",
"resource_id": 0,
"config": { },
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"name": "string",
"description": "string",
"code": 0,
"category": "string",
"event_type": "SHARE",
"resource_type": "ORG"
}

Modify a Notification Setting

Modifies a notification if a valid ID and body are provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_setting_id

required

integer

The unique ID of the notification setting.

Request Body schema: application/json

channel

string

Enum: "APP" "EMAIL" "SMS" "SLACK" "WEBHOOKS"

status

string

Enum: "PAUSED" "ACTIVE"

Whether or not the user should be notified about this event for this resource on the selected channel.

object

Configuration properties for customizing the criteria for firing the event.

config_property*

additional property

string

Set the relevant configuration properties if you want to override the default platform settings.

notification_resource_type

string

Enum: "ORG" "USER" "DATA_FLOW" "CUSTOM_DATA_FLOW" "SOURCE" "DATASET" "SINK"

resource_id

integer

checked

boolean

notification_channel_setting_id

integer

notification_type_id

integer

Responses

Request samples

Payload

Content type

application/json

{"channel": "APP",
"status": "PAUSED",
"config": {"config_property1": "string",
"config_property2": "string"
},
"notification_resource_type": "ORG",
"resource_id": 0,
"checked": true,
"notification_channel_setting_id": 0,
"notification_type_id": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"notification_resource_type": "ORG",
"resource_id": 0,
"config": { },
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"name": "string",
"description": "string",
"code": 0,
"category": "string",
"event_type": "SHARE",
"resource_type": "ORG"
}

Delete a Notification Setting

Delete a notification setting if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

notification_setting_id

required

integer

The unique ID of the notification setting.

Responses

Get Notification Settings for an Event

Use this endpoint to fetch all notification settings of a specific type.

This can be used as a filter that is easy to use to understand, which returns all notifications that a user can expect to receive for a specific event.

Authorizations:

NexlaSessionToken

path Parameters

notification_type_id

required

integer

The unique ID of the notification type.

query Parameters

expand

boolean

Responses

Response samples

200

Content type

application/json

[{"setting_id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"resource_type": "ORG",
"resource_id": 0,
"setting_config": "string",
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"setting_created_at": "string",
"setting_updated_at": "string",
"notification_type_name": "string",
"notification_type_description": "string",
"notification_type_code": 0,
"notification_type_category": "string",
"notification_type_event_type": "SHARE",
"resource_owner_id": 0,
"resource_org_id": 0,
"resource_name": "string",
"resource_description": "string",
"resource_status": "INIT"
}
]

Get Notification Settings For a Resource

Use this endpoint to fetch all notification settings for a given resource.

This can be used as a filter that is easy to understand, which returns all notifications that a user can expect to receive for a specific resource.

Authorizations:

NexlaSessionToken

path Parameters

resource_id required	integer Example: 2
resource_type required	string Enum: "ORG" "USER" "DATA_FLOW" "CUSTOM_DATA_FLOW" "SOURCE" "DATASET" "SINK"

query Parameters

expand	boolean
filter_overridden_settings	boolean
notification_type_id	integer Example: notification_type_id=1

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"org_id": 0,
"owner_id": 0,
"channel": "APP",
"notification_resource_type": "ORG",
"resource_id": 0,
"config": { },
"priority": 0,
"status": "PAUSED",
"notification_type_id": 0,
"name": "string",
"description": "string",
"code": 0,
"category": "string",
"event_type": "SHARE",
"resource_type": "ORG"
}
]

Metrics

Operations for retrieving metrics.

Get Total Account Metrics for An Organization

Retrieves total account utilization metrics for an organization. The result consists of aggregated information about records processed within the specified date range by all resources owned by users in the organization.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization. The result will be an aggregate of metrics for all resources owned by users in the organization.

query Parameters

from required	string <date-time> Example: from=2023-01-10 The date that should be considered as the start of the metrics aggregation period.
to	string <date-time> Example: to=2023-01-17T20:24:35Z The date that should be considered as the end of the metrics aggregation period. In the absence of this parameter, the API returns metrics aggregated up to the current date.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"status": 0,
"metrics": [{"data": {"records": 0,
"size": 0
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
]
}

Get Total Account Metrics for a User

Retrieves total account utilization metrics for a user in an organization. The result consists of aggregated information about records processed within the specified date range by all resources owned by the user.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user. The result will be an aggregate of metrics for all resources owned by this user.

query Parameters

org_id	integer The ID of the organization this user belongs to. This parameter is relevant for users who belong to multiple organizations. In the absence of this parameter, the API returns an aggregate of metrics for all resources owned by the user in the user's default organization. Set this query parameter to fetch metrics for a different organization.
from required	string <date-time> Example: from=2023-01-10 The date that should be considered as the start of the metrics aggregation period.
to	string <date-time> Example: to=2023-01-17 The date that should be considered as the end of the metrics aggregation period. In the absence of this parameter, the API returns metrics aggregated up to the current date.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"status": 0,
"metrics": [{"data": {"records": 0,
"size": 0
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
]
}

Get 24 Hour Flow Stats for a User

Retrieves the metrics and processing status of each flow that processed data in the last 24 hours.

Each item reflects the total number of records processed by each stage of all flows accessible by the user that processed any data in the specified time window.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user whose flows are to be fetched.

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"status": 0,
"metrics": {"sources": {"data_source_id1": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
},
"data_source_id2": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
}
},
"sinks": {"data_sink_id1": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
},
"data_sink_id2": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
}
},
"datasets": {"data_set_id1": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
},
"data_set_id2": {"records": 0,
"size": 0,
"errors": 0,
"status": "OK"
}
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
}

Get Daily Data Processing Metrics for a User

Retrieves daily data processing metrics of all sources or all destinations owned by a user.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user. The result will be an aggregate of metrics for all resources owned by this user.

query Parameters

org_id	integer The ID of the organization this user belongs to. This parameter is relevant for users who belong to multiple organizations. In the absence of this parameter, the API returns an aggregate of metrics for all resources owned by the user in the user's default organization. Set this query parameter to fetch metrics for a different organization.
resource_type required	string Enum: "SOURCE" "SINK" The type of resource that metrics should be fetched for. Select `SOURCE` for the total data ingested by all sources owned by the user. Select `SINK` for the total data written out by all sinks owned by the user.
from required	string <date-time> Example: from=2023-01-10 The date that should be considered as the start of the metrics reporting period.
to	string <date-time> Example: to=2023-01-17 The date that should be considered as the end of the metrics reporting period. In the absence of this parameter, the API returns metrics up to the current date.
aggregate required	integer This should be set to 1 for fetching daily aggregated metrics over the specified time range.

Responses

Response samples

200

Content type

application/json

{"metrics": [{"time": "2019-08-24",
"records": 0,
"size": 0,
"errors": 0
}
],
"status": 0
}

Get Daily Metrics for a Resource of a Flow

Retrieves daily data processing metrics of a data_source, data_set, or data_sink.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of resource that metrics should be fetched for.
resource_id required	integer The ID of resource that metrics should be fetched for.

query Parameters

from required	string <date-time> Example: from=2023-01-10 The date that should be considered as the start of the metrics reporting period.
to	string <date-time> Example: to=2023-01-17 The date that should be considered as the end of the metrics reporting period. In the absence of this parameter, the API returns metrics up to the current date.
aggregate required	integer This should be set to 1 for fetching daily aggregated metrics over the specified time range.

Responses

Response samples

200

Content type

application/json

{"metrics": [{"time": "2019-08-24",
"records": 0,
"size": 0,
"errors": 0
}
],
"status": 0
}

Get Metrics By Run ID for a Resource of a Flow

Retrieves data processing metrics of a data_source, data_set, or data_sink. The reported metrics are grouped by run id to indicate the number of records processed during each ingestion cycle of this flow.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of resource that metrics should be fetched for.
resource_id required	integer The unique id of the resource you wish to fetch metrics for. For ex, set this to id of the `data_source` if you want to fetch metrics of a specific `data_source`.
groupby	string Enum: "runId" "lastWritten" Specify the rule based on which metrics should be grouped for aggregation. Default API behavior is to group by `runId`. This choice is only applicable for data sinks where the run summary could be reported by `runId` ( for reporting number of records written out per ingestion cycle) or `lastWritten` (for reporting number of records written out in each destination write batch).
orderby	string Enum: "runId" "lastWritten" Specify the order in which paginated results should be sorted. Default API behavior is to order by `runId`. This choice is only applicable for data sinks where the run summary could be reported by `runId` ( for reporting number of records written out per ingestion cycle) or `lastWritten` (for reporting number of records written out in each destination write batch).

query Parameters

page	integer Add this parameter to a resource fetch request to fetch a specific page of data.
size	integer Add this parameter to a resource fetch request to set the number of items that should be returned in each request.

Responses

Response samples

200

Content type

application/json

{"metrics": {"data": [{"runId": 0,
"lastWritten": 0,
"dataSetId": 0,
"records": 0,
"size": 0,
"errors": 0
}
],
"meta": {"currentPage": 0,
"pageCount": 0,
"totalCount": 0
}
},
"status": 0
}

Get Metrics for a Flow

Retrieves data processing metrics of a flow. Metrics are aggregated for each node of the flow for the specified time range. They can be be further grouped by run id to indicate the number of records processed during each ingestion cycle of this flow.

Note: This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.
groupby	string Value: "runId" Specify the rule based on which metrics should be grouped for aggregation. This is an optional property. If present and set to `runId` the response will contain one entry per run id, with each entry containing metrics for all resources that processed data during that run.
orderby	string Enum: "runId" "created_at" Specify the order in which paginated results should be sorted.

query Parameters

from required	string <date-time> Example: from=2023-01-10 The date that should be considered as the start of the metrics aggregation period.
to	string <date-time> Example: to=2023-01-17 The date that should be considered as the end of the metrics aggregation period. In the absence of this parameter, the API returns metrics aggregated up to the current date.
page	integer Add this parameter to a resource fetch request to fetch a specific page of data.
per_page	integer Add this parameter to a resource fetch request to set the number of items that should be returned in each request.

Responses

Response samples

200

Content type

application/json

{"status": 0,
"message": "string",
"metrics": {"data": {"run_id1": {"data_sources": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
],
"data_sets": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
],
"data_sinks": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
]
},
"run_id2": {"data_sources": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
],
"data_sets": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
],
"data_sinks": [{"id": 0,
"metric": {"records": 0,
"size": 0,
"errors": 0
}
}
]
}
},
"meta": {"currentPage": 0,
"pageCount": 0,
"totalCount": 0
}
}
}

Get Flow Execution Logs for Run ID of a Flow

Retrieves flow execution logs for a specific run id of a flow.

Note: This is a variant of flow endpoints where the flow node can referenced not by its own ID, but by the ID of the unique resource that is linked to that flow node.

Authorizations:

NexlaSessionToken

path Parameters

resource_type required	string Enum: "data_sources" "data_sinks" "data_sets" The type of node linked to the flow you want to reference. For ex, set this to `data_sources` if you want to refer to the flow originating in a `data_source`.
resource_id required	integer The unique id of the resource whose flow you want to reference. For ex, set this to id of the `data_source` if you want to refer to the flow originating in a specific `data_source`.

query Parameters

run_id required	integer Example: run_id=1695442864636 The run id (denoting the ingestion cycle) for which logs have to be fetched.
from required	integer <unix epoch in milliseconds> Example: from=1695442864636 The timestamp that should be considered as the start of the logs reporting period.
to	integer <unix epoch in milliseconds> Example: to=1695442864636 The timestamp that should be considered as the end of the logs reporting period. In the absence of this parameter, the API returns metrics up to the current time.
page	integer Add this parameter to a resource fetch request to fetch a specific page of data.
per_page	integer Add this parameter to a resource fetch request to set the number of items that should be returned in each request.

Responses

Response samples

200

Content type

application/json

{"status": 0,
"message": "string",
"logs": {"data": [{"timestamp": 1695442864636,
"resource_id": 0,
"resource_type": "SOURCE",
"log": "Processed records=100, errors=0, size=94162\"",
"log_type": "LOG",
"severity": "INFO"
}
],
"meta": {"current_page": 0,
"pages_count": 0,
"total_count": 0,
"org_id": 0,
"run_id": 0
}
}
}

Audit Logs

Operations for reviewing the change history of resources.

Get Audit Log for a Data Source

Retrieves the history of changes made to the properties of a data source.

Authorizations:

NexlaSessionToken

path Parameters

data_source_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Data Sink

Retrieves the history of changes made to the properties of a data sink.

Authorizations:

NexlaSessionToken

path Parameters

data_sink_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Nexset

Retrieves the history of changes made to the properties of a Nexset.

Authorizations:

NexlaSessionToken

path Parameters

data_set_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Data Credential

Retrieves the history of changes made to the properties of a data credential.

Authorizations:

NexlaSessionToken

path Parameters

data_credential_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Data Map

Retrieves the history of changes made to the properties of a data map.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Data Schema

Retrieves the history of changes made to the properties of a data schema.

Authorizations:

NexlaSessionToken

path Parameters

data_schema_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Code Container

Retrieves the history of changes made to the properties of a code container. This endpoint can also be used to fetch the history of changes made to any transform object.

Authorizations:

NexlaSessionToken

path Parameters

code_container_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Project

Retrieves the history of changes made to the properties of a project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Document

Retrieves the history of changes made to the properties of a document.

Authorizations:

NexlaSessionToken

path Parameters

doc_container_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a User

Retrieves the history of changes made to the properties of a user.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for an Organization

Retrieves the history of changes made to the properties of an organization.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Get Audit Log for a Team

Retrieves the history of changes made to the properties of a team.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the resource being queried.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"item_type": "DataSource",
"item_id": 0,
"event": "association_added",
"change_summary": ["status"
],
"object_changes": {"property_name1": ["string"
],
"property_name2": ["string"
]
},
"association_resource": {"type": "string",
"id": 0
},
"request_ip": "1.2.3.4",
"request_user_agent": "string",
"request_url": "string",
"user": {"id": 0,
"email": "user@nexla.com"
},
"impersonator_id": "string",
"org_id": 0,
"owner_id": 0,
"owner_email": "string",
"created_at": "2022-11-08T22:51:47.720Z"
}
]

Quarantine Settings

Operations for managing quarantine settings.

Get Quarantine Data Export Settings for A User

Retrieve Quarantine Data Export Settings for all resources owned by a user.

Nexla detects errors during different stages of data flow such as ingestion, transformation, and output. Error records are quarantined and accessible to the user via APIs as well as files. With Quarantine Data Export Settings, you can configure Nexla to write files containing information about erroneous records across all resources owned by a user.

This endpoint returns a 404 status code if no Quarantine Data Export Settings have been configured for the user.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user whose quarantine settings you wish to retrieve.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"resource_type": "ORG",
"resource_id": 0,
"config": {"start.cron": "0 50 18 1 1/1 ? *",
"path": "/nexla_error_data/export"
},
"data_credentials_id": 0,
"credentials_type": "gdrive",
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["string"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}
}

Set Quarantine Data Export Settings for A User

Sets Quarantine Data Export Settings for all resources owned by a user so that all erroneous records can be automatically exported by the platform to a file system regularly.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/vnd.nexla.api.v1+json

data_credentials_id

required

integer

Nexla data credential to a file storage system where all error data should be exported. Configure the base folder within the location accessible by this credential by setting an appropriate value for configure["path"].

required

object

start.cron required	string The interval at which Nexla should scan all quarantined records in the user's account and export them to the specified file storage. This should be a valid cron expression.
path required	string The base folder where all quarantined records will be exported. Nexla will automatically create subfolder tree in this base folder when exporting error data files. These subfolders will be of the pattern `<base-path>/<nexla-env-code>/<resource-type>/<resource-id>/<yyyy>/<MM>/<dd>/<unique-file-name>.json`

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"data_credentials_id": 0,
"config": {"start.cron": "0 50 18 1 1/1 ? *",
"path": "/nexla_error_data/export"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"resource_type": "ORG",
"resource_id": 0,
"config": {"start.cron": "0 50 18 1 1/1 ? *",
"path": "/nexla_error_data/export"
},
"data_credentials_id": 0,
"credentials_type": "gdrive",
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["string"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}
}

Update Quarantine Data Export Settings for A User

Updates Quarantine Data Export Settings for all resources owned by a user so that all erroneous records can be automatically exported by the platform to a file system regularly.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Request Body schema: application/vnd.nexla.api.v1+json

data_credentials_id

integer

Nexla data credential to a file storage system where all error data should be exported. Configure the base folder within the location accessible by this credential by setting an appropriate value for configure["path"].

object

start.cron required	string The interval at which Nexla should scan all quarantined records in the user's account and export them to the specified file storage. This should be a valid cron expression.
path required	string The base folder where all quarantined records will be exported. Nexla will automatically create subfolder tree in this base folder when exporting error data files. These subfolders will be of the pattern `<base-path>/<nexla-env-code>/<resource-type>/<resource-id>/<yyyy>/<MM>/<dd>/<unique-file-name>.json`

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"data_credentials_id": 0,
"config": {"start.cron": "0 50 18 1 1/1 ? *",
"path": "/nexla_error_data/export"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"resource_type": "ORG",
"resource_id": 0,
"config": {"start.cron": "0 50 18 1 1/1 ? *",
"path": "/nexla_error_data/export"
},
"data_credentials_id": 0,
"credentials_type": "gdrive",
"data_credentials": {"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"access_roles": ["string"
],
"credentials_version": "string",
"managed": true,
"credentials_type": "string",
"connector": {"id": 0,
"type": "string",
"connection_type": "string",
"name": "string",
"description": "string",
"nexset_api_compatible": true
},
"api_keys": [ ],
"credentials_non_secure_data": {"credential_property1": "string",
"credential_property2": "string"
},
"verified_status": "string",
"verified_at": "2019-08-24T14:15:22Z",
"copied_from_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": [ ]
}
}

Delete Quarantine Data Export Settings for A User

Deletes Updates Quarantine Data Export Settings for all resources owned by a user. Deleting this setting will ensure the platform stops exporting all erroneous records for resources owned by the user to a file storage.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique id of the user.

Responses

Access Control

Operations for managing access control to resources

Get Access Rules on Data Source

Returns a list of the access-control rules set for this data source.

Authorizations:

NexlaSessionToken

path Parameters

data_source_id

required

integer

The unique ID of the data source.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Data Source

Replaces the list of accessors belonging to a data source. Existing accessors will be removed from the data source.

Authorizations:

NexlaSessionToken

path Parameters

data_source_id

required

integer

The unique ID of the data source.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Data Source

Adds a list of accessors to a data source. The existing accessors list is retained and merged with the new accessors list.

Authorizations:

NexlaSessionToken

path Parameters

data_source_id

required

integer

The unique ID of the data source.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Data Source

Removes access-control rules from a data source. If no request body is provided, all rules associated with the data source will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_source_id

required

integer

The unique ID of the data source.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Nexset

Returns a list of the access-control rules set for this Nexset.

Authorizations:

NexlaSessionToken

path Parameters

data_set_id

required

integer

The unique ID of the Nexset.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Nexset

Replaces the list of access-control rules set for this Nexset. Existing rules will be removed from the Nexset, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

data_set_id

required

integer

The unique ID of the Nexset.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Nexset

Adds new access-control rules to this Nexset.

Authorizations:

NexlaSessionToken

path Parameters

data_set_id

required

integer

The unique ID of the Nexset.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Nexset

Removes access-control rules from a Nexset. If no request body is provided, all rules associated with the Nexset will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_set_id

required

integer

The unique ID of the Nexset.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Data Sink

Returns a list of the access-control rules set for this data sink.

Authorizations:

NexlaSessionToken

path Parameters

data_sink_id

required

integer

The unique ID of the data sink.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Data Sink

Replaces the list of access-control rules set for this data sink. Existing rules will be removed from the data sink, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

data_sink_id

required

integer

The unique ID of the data sink.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Data Sink

Adds new access-control rules to this data sink.

Authorizations:

NexlaSessionToken

path Parameters

data_sink_id

required

integer

The unique ID of the data sink.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Data Sink

Removes access-control rules from a data sink. If no request body is provided, all rules associated with the data sink will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_sink_id

required

integer

The unique ID of the data sink.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Data Map

Returns a list of the access-control rules set for this data map.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Data Map

Replaces the list of access-control rules set for this data map. Existing rules will be removed from the data map, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Data Map

Adds new access-control rules to this data map.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Data Map

Removes access-control rules from a data map. If no request body is provided, all rules associated with the data map will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_map_id

required

integer

The unique ID of the data map.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Data Credential

Returns a list of the access-control rules set for this data credential.

Authorizations:

NexlaSessionToken

path Parameters

data_credential_id

required

integer

The unique ID of the data credential.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Data Credential

Replaces the list of access-control rules set for this data credential. Existing rules will be removed from the data credential, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

data_credential_id

required

integer

The unique ID of the data credential.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Data Credential

Adds new access-control rules to this data credential.

Authorizations:

NexlaSessionToken

path Parameters

data_credential_id

required

integer

The unique ID of the data credential.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Data Credential

Removes access-control rules from a data credential. If no request body is provided, all rules associated with the data credential will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_credential_id

required

integer

The unique ID of the data credential.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Project Accessors

Returns a list of the access-control rules set for this project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Project

Replaces the list of access-control rules set for this project. Existing rules will be removed from the project, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Project Accessors

Adds new access-control rules to this project.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Project Accessors

Removes access-control rules from a project. If no request body is provided, all rules associated with the project will be removed.

Authorizations:

NexlaSessionToken

path Parameters

project_id

required

integer

The unique ID of the project.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Flow

Returns a list of the access-control rules set for this flow.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the flow.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Flow

Replaces the list of access-control rules set for this flow. Existing rules will be removed from the flow, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

flow_id

required

string

The unique ID of the data flow.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Flow

Adds new access-control rules to this data flow.

Authorizations:

NexlaSessionToken

path Parameters

flow_id

required

string

The unique ID of the data flow.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Flow

Removes access-control rules from a data flow. If no request body is provided, all rules associated with the data flow will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the data flow.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Flow (Deprecated)

Returns a list of the access-control rules set for this data flow.

Note: This version of the endpoint has been deprecated. It uses a composite data flow id of the type {resource_type}/{resource_id}. See get_flow_accessors for a new version of this endpoint that uses unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the data flow. This ID is of the type {resource_type}/{resource_id}, where the resource is the root node of the flow - for example, data_source/1001.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Flow (Deprecated)

Replace the list of access-control rules set for this data flow. Existing rules will be removed from the data flow, and only these new rules will be applied. This version uses a composite data flow id of the type {resource_type}/{resource_id}.

Note: This version of the endpoint has been deprecated. It uses a composite data flow id of the type {resource_type}/{resource_id}. See replace_flow_accessors for a new version of this endpoint that uses unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the data flow. This ID is of the type {resource_type}/{resource_id}, where the resource is the root node of the flow - for example, data_source/1001.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Flow (Deprecated)

Add new access-control rules to this data flow. This version uses a composite data flow id of the type {resource_type}/{resource_id}.

Note: This version of the endpoint has been deprecated. It uses a composite data flow id of the type {resource_type}/{resource_id}. See add_flow_accessors for a new version of this endpoint that uses unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the data flow. This ID is of the type {resource_type}/{resource_id}, where the resource is the root node of the flow - for example, data_source/1001.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Flow (Deprecated)

Remove access-control rules from a data flow. If no request body is provided, all rules associated with the data flow will be removed. This version uses a composite data flow id of the type {resource_type}/{resource_id}.

Note: This version of the endpoint has been deprecated. It uses a composite data flow id of the type {resource_type}/{resource_id}. See delete_flow_accessors for a new version of this endpoint that uses unique flow_id.

Authorizations:

NexlaSessionToken

path Parameters

data_flow_id

required

string

The unique ID of the data flow. This ID is of the type {resource_type}/{resource_id}, where the resource is the root node of the flow - for example, data_source/1001.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Data Schema

Returns a list of the access-control rules set for this data schema.

Authorizations:

NexlaSessionToken

path Parameters

data_schema_id

required

integer

The unique ID of the data schema.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Data Schema

Replaces the list of access-control rules set for this data schema. Existing rules will be removed from the data schema, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

data_schema_id

required

integer

The unique ID of the data schema.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Data Schema

Adds new access-control rules to this data schema.

Authorizations:

NexlaSessionToken

path Parameters

data_schema_id

required

integer

The unique ID of the data schema.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Data Schema

Removes access-control rules from a data schema. If no request body is provided, all rules associated with the data schema will be removed.

Authorizations:

NexlaSessionToken

path Parameters

data_schema_id

required

integer

The unique ID of the data schema.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Document

Returns a list of the access-control rules set for this document.

Authorizations:

NexlaSessionToken

path Parameters

doc_container_id

required

integer

The unique ID of the document.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Document

Replaces the list of access-control rules set for this document. Existing rules will be removed from the document, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

doc_container_id

required

integer

The unique ID of the document.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Document

Adds new access-control rules to this document.

Authorizations:

NexlaSessionToken

path Parameters

doc_container_id

required

integer

The unique ID of the document container.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Document

Removes access-control rules from a document. If no request body is provided, all rules associated with the document will be removed.

Authorizations:

NexlaSessionToken

path Parameters

doc_container_id

required

integer

The unique ID of the document.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Access Rules on Code Container

Returns a list of the access-control rules set for this code container.

Authorizations:

NexlaSessionToken

path Parameters

code_container_id

required

integer

The unique ID of the code container.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Access Rules on Code Container

Replaces the list of access-control rules set for this code container. Existing rules will be removed from the code container, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

code_container_id

required

integer

The unique ID of the code container.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Access Rules on Code Container

Adds new access-control rules to this code container.

Authorizations:

NexlaSessionToken

path Parameters

code_container_id

required

integer

The unique ID of the code container.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Access Rules on Code Container

Removes access-control rules from a code container. If no request body is provided, all rules associated with the code container will be removed.

Authorizations:

NexlaSessionToken

path Parameters

code_container_id

required

integer

The unique ID of the code container.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Get Team Accessors

Returns a list of the access-control rules set for this team.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Responses

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Replace Team Accessors List

Replaces the list of access-control rules set for this team. Existing rules will be removed from the team, and only these new rules will be applied.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Add Team Accessors

Adds new access-control rules to this team.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Delete Team Accessors

Removes access-control rules from a team. If no request body is provided, all rules associated with the team will be removed.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of accessors.

Array of objects or objects or objects

Array

One of

type	string Value: "USER" Choose this option if the access permissions should be granted to a user. Note: Users can belong to multiple organizations. The platform allows granting access permission across organization boundaries only for Nexset `sharer` access role.
id	integer Unique ID of the user that should be granted this permission.
email	string `Optional`: Only user-id or email is required to identify the user who should be granted this access permission.
org_id	integer Users can belong to multiple organizations. Specify the org_id to explicitly set the organization context for this access permission. If this is not specified the platform will try to automatically assign the permission to the user's default organization (when granting sharer access on a Nexset) or to the current organization (for all other access roles).
access_roles	Array of strings Items Enum: "owner" "collaborator" "operator" "admin" This property reflects all the permissions the user/team/organization has to this resource. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. `administrator`: The user/team/organization has complete administrative rights to this resource. `owner`: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"accessors": [{"type": "USER",
"id": 0,
"email": "example@nexla.com",
"org_id": 0,
"access_roles": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"type": "ORG",
"email_domain": "nexla.com",
"client_identifier": "string",
"access_roles": ["owner"
],
"created_at": "2021-04-06T21:02:17.000Z",
"updated_at": "2021-04-06T21:02:17.000Z"
}
]

Organizations

Operations for managing the user's organization.

Get all Organizations

Returns all organizations accessible to the authenticated user.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"email_domain": "string",
"email": "user@example.com",
"client_identifier": "string",
"org_webhook_host": "string",
"default_cluster_id": 0,
"access_roles": ["owner"
],
"owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [ ],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"billing_owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [ ],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"admins": [ ],
"org_tier": {"id": 0,
"name": "string",
"display_name": "string",
"record_count_limit": 0,
"record_count_limit_time": "string",
"data_source_count_limit": 0,
"trial_period_days": 0
},
"members_default_access_role": "string",
"status": "string",
"default_reusable_code_container_access_role": "string",
"require_org_admin_to_publish": true,
"require_org_admin_to_subscribe": true,
"email_domain_verified_at": "2019-08-24T14:15:22Z",
"name_verified_at": "2019-08-24T14:15:22Z",
"enable_nexla_password_login": true,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]

Get Organization by ID

Returns an organization if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization that needs to be fetched.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": null,
"cluster_id": 0,
"new_cluster_id": null,
"cluster_status": "string",
"email_domain": "string",
"email": null,
"client_identifier": "string",
"org_webhook_host": "string",
"access_roles": ["owner"
],
"owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "string"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"billing_owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "string"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"admins": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"org_tier": {"id": 0,
"name": "string",
"display_name": "string",
"record_count_limit": 0,
"record_count_limit_time": "string",
"data_source_count_limit": 0,
"trial_period_days": 0
},
"members_default_access_role": "string",
"status": "string",
"default_reusable_code_container_access_role": "string",
"require_org_admin_to_publish": true,
"require_org_admin_to_subscribe": true,
"email_domain_verified_at": null,
"name_verified_at": null,
"enable_nexla_password_login": true,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Update an Organization

Updates properties of an organization.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization that needs to be updated.

Request Body schema: application/json

name	string
owner_id	integer
billing_owner_id	integer
email_domain	string
client_identifier	string Recommended but not required. This is a unique identifier for the organization in the environment. This identifier is especially useful for organizations that are using SSO. Recommendation: Use the organization's domain name. Apply variants if a company needs more than one organization account in the environment.
enable_nexla_password_login	boolean Set to `false` if an organization requires no user to be allowed username-password-based access. Applicable for organizations who use GSuite email or have SSO enabled. Default value: `true`

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"owner_id": 0,
"billing_owner_id": 0,
"email_domain": "string",
"client_identifier": "string",
"enable_nexla_password_login": true
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": null,
"cluster_id": 0,
"new_cluster_id": null,
"cluster_status": "string",
"email_domain": "string",
"email": null,
"client_identifier": "string",
"org_webhook_host": "string",
"access_roles": ["owner"
],
"owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "string"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"billing_owner": {"id": 0,
"email": "user@example.com",
"full_name": "string",
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": null,
"status": "string",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "string"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": null,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"admins": [{"id": 0,
"full_name": "string",
"email": "user@example.com"
}
],
"org_tier": {"id": 0,
"name": "string",
"display_name": "string",
"record_count_limit": 0,
"record_count_limit_time": "string",
"data_source_count_limit": 0,
"trial_period_days": 0
},
"members_default_access_role": "string",
"status": "string",
"default_reusable_code_container_access_role": "string",
"require_org_admin_to_publish": true,
"require_org_admin_to_subscribe": true,
"email_domain_verified_at": null,
"name_verified_at": null,
"enable_nexla_password_login": true,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Get All Members in Organization

Retrieves a list of all users in an organization.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization.

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"full_name": "string",
"email": "string",
"is_admin?": true,
"access_role": ["owner"
],
"org_membership_status": "ACTIVE",
"user_status": "ACTIVE"
}
]

Update Organization Members

Add or update members in an organization. This endpoint can also be used to modify an existing member's role in the organization.

When adding a new member using their email id, if a user account for that email id does not exist on the platform then a new user account will be created. If the user already exists on the platform as a member of a different organization then their membership will get updated to include this organization also.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects

Array

One of

id

required

integer

Nexla User ID of the user to be added or updated.

access_role

Array of strings

Items Enum: "owner" "collaborator" "operator" "admin"

This property reflects all the permissions the user/team/organization has to this resource.

collaborator: The user/team/organization can view the resource but not make any modifications to it.
operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
administrator: The user/team/organization has complete administrative rights to this resource.
owner: This user created the resource and so has complete administrative rights to it.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"members": [{"id": 0,
"access_role": ["owner"
]
}
]
}

Response samples

200

Content type

application/json

[{"id": 0,
"full_name": "string",
"email": "string",
"is_admin?": true,
"access_role": ["owner"
],
"org_membership_status": "ACTIVE",
"user_status": "ACTIVE"
}
]

Remove Members from an Organization.

Removes one or more members from the organization. Note that this will not delete the user account from the platform, but will remove the user's ability to access this organization's resources.

Authorizations:

NexlaSessionToken

path Parameters

org_id

required

integer

The unique ID of the organization.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects or objects

Array

One of

id

required

integer

Nexla User ID of the user who should be removed.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"members": [{"id": 0
}
]
}

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Users

Operations for managing user settings.

Create a User

Create a new user in this environment.

This requires admin access to the provided organization.

Authorizations:

NexlaSessionToken

Request Body schema: application/json

full_name required	string
email required	string
default_org_id	integer
status	string Enum: "ACTIVE" "DEACTIVATED" "SOURCE_COUNT_CAPPED" "SOURCE_DATA_CAPPED" "TRIAL_EXPIRED" Indicates the user's account status across all organizations they are members of.
user_tier_id	integer
user_tier	string
password	string
tos_signed_at	string <date-time>
	string or boolean or Array of objects
One of string Value: "*"

Responses

Request samples

Payload

Content type

application/json

{"full_name": "string",
"email": "string",
"default_org_id": 0,
"status": "ACTIVE",
"user_tier_id": 0,
"user_tier": "string",
"password": "string",
"tos_signed_at": "2019-08-24T14:15:22Z",
"admin": "*"
}

Response samples

200

Content type

application/json

{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Get All Users

Returns all users that can be viewed by authenticated user.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]

Get All Users with Expanded References

Returns all users that can be viewed by the authenticated user.

Authorizations:

NexlaSessionToken

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"account_summary": {"data_sources": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_sets": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_sinks": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_maps": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0
}
}
}
}
]

Modify a User

Modifies a user's information and settings if a valid ID and body are provided

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user.

Request Body schema: application/json

name	string
email	string
status	string Enum: "ACTIVE" "DEACTIVATED" "SOURCE_COUNT_CAPPED" "SOURCE_DATA_CAPPED" "TRIAL_EXPIRED" Indicates the user's account status across all organizations they are members of.
user_tier_id	integer
user_tier	string
password	string
password_confirmation	string
password_current	string
tos_signed_at	string <date-time>
	string or boolean or Array of objects
One of string Value: "*"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"status": "ACTIVE",
"user_tier_id": 0,
"user_tier": "string",
"password": "string",
"password_confirmation": "string",
"password_current": "string",
"tos_signed_at": "2019-08-24T14:15:22Z",
"admin": "*"
}

Response samples

200

Content type

application/json

{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Get User by ID

Returns a user if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Get User by ID with Expanded References

Returns a user if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

user_id

required

integer

The unique ID of the user.

query Parameters

required

integer or boolean

Truthy parameter for requesting expanded references.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"email": "user@example.com",
"full_name": "string",
"super_user": true,
"impersonated": true,
"default_org": {"id": 0,
"name": "string"
},
"user_tier": "FREE",
"status": "ACTIVE",
"account_locked": true,
"org_memberships": [{"id": 0,
"name": "string",
"is_admin?": true,
"org_membership_status": "ACTIVE"
}
],
"email_verified_at": "2019-08-24T14:15:22Z",
"tos_signed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"account_summary": {"data_sources": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_sets": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_sinks": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0,
"active": 0,
"paused": 0,
"draft": 0
}
},
"data_maps": {"counts": {"total": 0,
"owner": 0,
"collaborator": 0
}
}
}
}

Teams

Operations for managing teams.

Get all Teams

Returns all teams accessible to the authenticated user.

Authorizations:

NexlaSessionToken

query Parameters

access_role

string

Enum: "collaborator" "operator" "admin" "owner"

Add this query parameter to a request to view resources for which the authenticated user has permission.

collaborator: Resources to which the user has access via the collaborator or higher permissions.
operator: Resources to which the user has access via the operator or higher permissions.
admin: Resources to which the user has access via the administrator or owner permissions.
owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Nexla API access roles

header Parameters

Accept

string

Enum: "application/vnd.nexla.api.v1+json" "application/json"

Setting to application/vnd.nexla.api.v1+json is recommended.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"member": true,
"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
],
"access_roles": ["owner"
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}
]

Create a team

Creates a team with the specified configuration and members.

Authorizations:

NexlaSessionToken

Request Body schema: application/vnd.nexla.api.v1+json

name

required

string

description

string

Array of objects or objects

Array

One of

id	integer Unique ID of the user.
admin	boolean Reflects whether the user is an administrator of this team or not.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"name": "string",
"description": "string",
"members": [{"id": 0,
"admin": true
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"member": true,
"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
],
"access_roles": ["owner"
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Get Team by ID

Returns a team if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"member": true,
"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
],
"access_roles": ["owner"
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Modify a Team

Modifies a team's information and settings if a valid ID and body are provided.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

name

string

description

string

Array of objects or objects

Array

One of

id	integer Unique ID of the user.
admin	boolean Reflects whether the user is an administrator of this team or not.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"name": "string",
"description": "string",
"members": [{"id": 0,
"admin": true
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"owner": {"id": 0,
"full_name": "string",
"email": "string",
"email_verified_at": "2019-08-24T14:15:22Z"
},
"org": {"id": 0,
"name": "string",
"email_domain": "string",
"email": "string",
"client_identifier": "string",
"org_webhook_host": "string"
},
"member": true,
"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
],
"access_roles": ["owner"
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"tags": ["string"
]
}

Delete Team by ID

Deletes a team if a valid ID is provided.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Responses

Get Team Members

Returns a list of the members belonging to a team.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Responses

Response samples

200

Content type

application/json

[{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}
]

Replace Team Members List

Replaces the list of members belonging to a team. Existing members will be removed from the team.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects

Array

id	integer Unique ID of the user.
email	string <email> Email ID of the user.
admin	boolean Reflects whether the user is an administrator of this team or not.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}

Response samples

200

Content type

application/json

[{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}
]

Add Members to A Team

Adds a list of members to a team. The existing list of members will be retained and merged with the new list of members.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Array of objects

Array

id	integer Unique ID of the user.
email	string <email> Email ID of the user.
admin	boolean Reflects whether the user is an administrator of this team or not.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}

Response samples

200

Content type

application/json

[{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}
]

Remove Team Members

Removes members from a team. If no request body is provided, all members belonging to the team will be removed.

Authorizations:

NexlaSessionToken

path Parameters

team_id

required

integer

The unique ID of the team.

Request Body schema: application/vnd.nexla.api.v1+json

Optional list of members.

Array of objects

Array

id	integer Unique ID of the user.
email	string <email> Email ID of the user.
admin	boolean Reflects whether the user is an administrator of this team or not.

Responses

Request samples

Payload

Content type

application/vnd.nexla.api.v1+json

{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}

Response samples

200

Content type

application/json

[{"members": [{"id": 0,
"email": "user@example.com",
"admin": true
}
]
}
]

Webhooks

Operations for sending events to the Nexla webhook connector.

Send one record to Webhook Webhook | POST

Authorizations:

NexlaApiKeyQueryNexlaApiKeyHeader

path Parameters

include_headers	boolean Set this to `true` if you wish to send any custom headers to be included in the ingested records as part of the request. The platform will ignore standard headers like `Authorization` and `Content-Type`. Any custom headers will be added as a `header_<header_name>` attribute in the record. Example: The request header `NEX-HEADER: test` will be ingested as the attribute `header_NEX-HEADER` with the value `test`. Default value: `false`
include_url_params	boolean Set this to `true` if you wish to send any custom query parameters to be included in the ingested records as part of the request. The platform will ignore standard query parameters like `api_key`. Any custom query parameters will be added as a `url_param_<param_name>` attribute in the record. Example: The request query parameter `abc=def` will be ingested as the attribute `url_param_abc` with the value `def`. Default value: `false`
force_schema_detection	boolean Usually, the platform performs Nexset schema detection only for the first few records from a new webhook. This is to avoid any unncessary latencies in webhook record processing. Set this to `true` if you wish to enforce any webhook event to trigger schema detection. Default value: `false`

Request Body schema:
application/json

attribute_name*

additional property

string

Property Name: Attribute name in the record.

Property Value: Attribute value in the record.

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "one"
}

Response samples

200
500

Content type

application/json

{"datasetId": 0,
"processed": 0
}

Send many records to Webhook Webhook | POST

Send an array of JSON objects. Nexla will treat each object as a unique record for the webhook.

Authorizations:

NexlaApiKeyQueryNexlaApiKeyHeader

path Parameters

include_headers	boolean Set this to `true` if you wish to send any custom headers to be included in the ingested record as part of the request. The platform will ignore standard headers like `Authorization` and `Content-Type`. Any custom headers will be added as a `header_<header_name>` attribute in the record. Example: The request header `NEX-HEADER: test` will be ingested as the attribute `header_NEX-HEADER` with the value `test`. Default value: `false`
include_url_params	boolean Set this to `true` if you wish to send any custom query parameters to be included in the ingested records as part of the request. The platform will ignore standard query parameters like `api_key`. Any custom query parameters will be added as a `url_param_<param_name>` attribute in the record. Example: The request query parameter `abc=def` will be ingested as the attribute `url_param_abc` with the value `def`. Default value: `false`
force_schema_detection	boolean Usually, the platform performs Nexset schema detection only for the first few records from a new webhook. This is to avoid any unnecessary latencies in webhook record processing. Set this to `true` if you wish to enforce any webhook event to trigger schema detection. Default value: `false`

Request Body schema: application/json

Array

attribute_name*

additional property

string

Property Name: Attribute name in the record.

Property Value: Attribute value in the record.

Responses

Request samples

Payload

Content type

application/json

[{"attribute_name1": "string",
"attribute_name2": "string"
}
]

Response samples

200
500

Content type

application/json

{"datasetId": 0,
"processed": 0
}

Limits

Rate limit endpoints

Get current rate limit and usage

Returns the API rate limiting categories and the user's current usage

Authorizations:

NexlaSessionToken

Responses

Response samples

200

Content type

application/json

{"second": {"common": {"limit": 0,
"count": 0
},
"light": {"limit": 0,
"count": 0
},
"medium": {"limit": 0,
"count": 0
},
"high": {"limit": 0,
"count": 0
}
},
"day": {"common": {"limit": 0,
"count": 0
},
"light": {"limit": 0,
"count": 0
},
"medium": {"limit": 0,
"count": 0
},
"high": {"limit": 0,
"count": 0
}
}
}