Create a Datasource

post

https://senaps.eratos.com/api/datasource/v1/datasource

Create a new Datasource

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Datasource that should be created

A datasource object. Contains enough information to orchestrate the creation of Senaps resources to permit the ingestion of data.

string

Generated field. May be omitted in POST. Expected format: UUIDv4

name

string

required

Short, human readable name

description

string | null

required

Human readable datasource description

type

string

enum

required

Type of datasource

Allowed:

organisationid

string

required

Senaps Organisation ID for an organisation that is considered to 'own' this datasource.

groupid

string | null

required

Senaps Group ID for a group that is considered to 'own' this datasource.

enabled

boolean

required

Controls whether the datasource will be active in the platform. Disable to stop data being ingested.

config

object

required

A configuration object for the datasource matching one of the supported configuration schemas.
Should have its 'type' field set to the same value as the datasource 'type' field. Failure to do this will result
in serialisation errors or rejection of your request.

Responses

401

Authentication required

403

Unauthorised

500

Internal server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Datasource created