List Model Lab projects

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/projectshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/projectshttps://api.datadoghq.eu/api/v2/model-lab-api/projectshttps://api.ddog-gov.com/api/v2/model-lab-api/projectshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/projectshttps://api.datadoghq.com/api/v2/model-lab-api/projectshttps://api.us3.datadoghq.com/api/v2/model-lab-api/projectshttps://api.us5.datadoghq.com/api/v2/model-lab-api/projects

Overview

List all Model Lab projects for the current organization.

Arguments

Query Strings

Name

Type

Description

filter

string

Text search filter for project name or description.

filter[owner_id]

string

Filter by owner UUID.

filter[tags]

string

Filter by tags. Format: key:value,key2:value2.

sort

string

Sort field. Valid values: name, created_at, updated_at. Prefix with ‘-’ for descending order (e.g., -updated_at).

page[size]

integer

Number of items per page. Maximum is 100.

page[number]

integer

Page number (1-indexed).

Response

OK

Response containing a list of Model Lab projects with pagination metadata.

Expand All

Field

Type

Description

data [required]

[object]

The list of projects.

attributes [required]

object

Attributes of a Model Lab project.

artifact_storage_location [required]

string

The storage location for project artifacts.

created_at [required]

date-time

The date and time the project was created.

deleted_at

date-time

The date and time the project was soft-deleted.

description [required]

string

A description of the project.

external_url

string

An optional external URL associated with the project.

is_starred [required]

boolean

Whether the project is starred by the current user.

name [required]

string

The name of the project.

owner_id

string

The UUID of the project owner.

tags [required]

[object]

The list of tags associated with the project.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the project was last updated.

id [required]

string

The unique identifier of the project.

type [required]

enum

The JSON:API type for a Model Lab project resource. Allowed enum values: projects

links

object

Pagination links for navigating list responses.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta [required]

object

Pagination metadata for a list response.

page [required]

object

Pagination details for a list response.

first_number

int64

The first page number.

last_number

int64

The last page number.

next_number

int64

The next page number.

number [required]

int64

The current page number.

prev_number

int64

The previous page number.

size [required]

int64

The number of items per page.

total [required]

int64

The total number of items.

type

string

The pagination type.

{
  "data": [
    {
      "attributes": {
        "artifact_storage_location": "s3://bucket/active-project",
        "created_at": "2024-01-20T10:00:00Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "description": "A machine learning training project.",
        "external_url": "string",
        "is_starred": false,
        "name": "active-project",
        "owner_id": "string",
        "tags": [
          {
            "key": "model",
            "value": "opus"
          }
        ],
        "updated_at": "2024-01-20T11:00:00Z"
      },
      "id": "2",
      "type": "projects"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": 1,
      "prev_number": "integer",
      "size": 25,
      "total": 100,
      "type": "string"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Internal Server Error

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/model-lab-api/projects" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"