Projects¶

Projects group database connections and data sources. The API reads projects; create and change them in the dashboard. Authentication, pagination and errors are described in the Overview.

Method	Path	Description
`GET`	`/v1/projects`	List projects
`GET`	`/v1/projects/{project_id}`	Get a project

List projects¶

GET /v1/projects

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	No	Maximum number of rows to return (default: 200, max: 5000)

Responses

Status	Description	Body
`200`	List projects	array of Project
`400`	Invalid limit	ApiError
`401`	Not authenticated	ApiError
`500`	Internal error	ApiError

Example

curl -X GET 'https://digna.example.com/v1/projects' \
  -H "Authorization: Bearer $DIGNA_API_KEY"

Get a project¶

GET /v1/projects/{project_id}

Parameters

Name	In	Type	Required	Description
`project_id`	path	integer	Yes	Project ID

Responses

Status	Description	Body
`200`	Get a project	Project
`401`	Not authenticated	ApiError
`404`	Project not found	ApiError
`500`	Internal error	ApiError

Example

curl -X GET 'https://digna.example.com/v1/projects/<project_id>' \
  -H "Authorization: Bearer $DIGNA_API_KEY"

Schemas¶

ApiError¶

Field	Type	Required	Description
`code`	ApiErrorCode	Yes
`message`	string	Yes

Project¶

Field	Type	Required
`db_connections`	array of ProjectDbConnection	Yes
`description`	string	Yes
`id`	integer	Yes
`name`	string	Yes

ApiErrorCode¶

One of: INTERNAL_ERROR, INVALID_CREDENTIALS, NOT_FOUND, NOT_AUTHENTICATED, NOT_AUTHORIZED, INVALID_LICENSE, BAD_REQUEST.

ProjectDbConnection¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes