Data8 Administration & Batch Data Cleansing API

Manage your Data8 account, submit data to batch data cleansing jobs and retrieve the results

Jobs are submitted to workflows that are built for you by the Data8 Production Team to your specifications, and the details of the data to be provided to each workflow and generated by it will be documented by them.

If you do not already have a workflow available to submit jobs to, please get in touch with your account manager to discuss your requirements.

All requests must be authenticated using an Authorization: Bearer header, with the bearer token being obtained from the Data8 OAuth token server at https://auth.data-8.co.uk/connect/token.

/ApiKey

GET

/ApiKey

Gets a list of the API keys defined for this account

Parameters

No parameters.

Responses

A list of the API keys defined for this account

POST

/ApiKey

Creates a new API key

Parameters

No parameters.

Request Body

The details of the key to create

Example Value

Schema

{
	"key": "string",
	"description": "string",
	"username": "string",
	"expiresOn": "1970-01-01T00:00:00.0000000Z",
	"maxRequestsPerIPPerDay": 0,
	"isClientKey": true
}

Responses

The details of the newly created key

Example Value

Schema

{
	"key": "string",
	"description": "string",
	"username": "string",
	"expiresOn": "1970-01-01T00:00:00.0000000Z",
	"maxRequestsPerIPPerDay": 0,
	"allowedDomains": [],
	"allowedIPs": [],
	"allowedServices": []
}

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

GET

/ApiKey/{key}

Gets the details of an API key

Parameters

The unique identifier for the API key

Responses

The full details of the requested key

Example Value

Schema

{
	"key": "string",
	"description": "string",
	"username": "string",
	"expiresOn": "1970-01-01T00:00:00.0000000Z",
	"maxRequestsPerIPPerDay": 0,
	"allowedDomains": [],
	"allowedIPs": [],
	"allowedServices": []
}

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

PUT

/ApiKey/{key}

Updates an API key

Parameters

The unique identifier for the API key to update

Request Body

The updated details of the API key

Example Value

Schema

{
	"key": "string",
	"description": "string",
	"username": "string",
	"expiresOn": "1970-01-01T00:00:00.0000000Z",
	"maxRequestsPerIPPerDay": 0,
	"isClientKey": true
}

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

DELETE

/ApiKey/{key}

Deletes an API key

Parameters

The unique identifier of the API key to delete

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

GET

/ApiKey/{key}/allowedDomains

Gets the domain names that an API key can be used from

Parameters

The unique identifier of the API key to get the list of allowed domain names for

Responses

A list of the domain names that the API key can be used in client-side code from

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

PUT

/ApiKey/{key}/allowedDomains/{domain}

Adds a domain to the list that an API key can be used from in client-side code

Parameters

The unique identifier of the API key to add an allowed domain to

The domain name that the API key can be used from

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

DELETE

/ApiKey/{key}/allowedDomains/{domain}

Removes a domain from the list that an API key can be used from in client-side code

Parameters

The unique identifier of the API key to remove an allowed domain from

The domain name that the API key can no longer be used from

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

GET

/ApiKey/{key}/allowedIPs

Gets the client IP addresses that an API key can be used from

Parameters

The unique identifier of the API key to get the list of allowed domain names for

Responses

A list of the client IP addresses that the API key can be used from

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

POST

/ApiKey/{key}/allowedIPs

Adds an IP address to the list that an API key can be used from

This method will attempt to parse network as an IP address range. In this case it should be presented as a CIDR string, e.g. 123.45.6.0/24

If this is used in a key that will be used from client-side code, all clients must connect from an allowed IP address. In most cases this list will be left blank for client-side keys to allow users to connect from any IP address, but would be tightly restricted for server-side keys where all requests are made from a small range of known IP addresses.

Parameters

The unique identifier of the API key to add an allowed domain to

Request Body

The subnet that the API key can be used from

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

PUT

/ApiKey/{key}/allowedIPs/{network}/{prefix}

Adds an IP address to the list that an API key can be used from

If prefix is left blank, this method will attempt to parse network as an IP address range. In this case it should be presented as a CIDR string, e.g. 123.45.6.0/24

Parameters

The unique identifier of the API key to add an allowed domain to

The subnet that the API key can be used from

The number of bits of the network that identifies the allowed subnet

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

DELETE

/ApiKey/{key}/allowedIPs/{network}/{prefix}

Removes an IP address from the list that an API key can be used from

Parameters

The unique identifier of the API key to remove an allowed domain from

The subnet that the API key can no longer be used from

The number of bytes of the network that identifies the allowed subnet

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

GET

/ApiKey/{key}/allowedServices

Gets the services that an API key can be used to access

Parameters

The unique identifier of the API key to get the list of allowed domain names for

Responses

A list of the service names that the API key can be used to access

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

PUT

/ApiKey/{key}/allowedServices/{service}

Adds a service to the list that an API key can be used to access

Parameters

The unique identifier of the API key to add an allowed domain to

The name of the service that the API key can be used to access

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}

DELETE

/ApiKey/{key}/allowedServices/{service}

Removes a service from the list that an API key can be used to access

Parameters

The unique identifier of the API key to remove an allowed domain from

The name of the service that the API key can no longer be used to access

Responses

Example Value

Schema

{
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string"
}