diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 9f8d3285ca3..885046e02c0 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -9512,22 +9512,6 @@ menu: unstable: - v2 order: 5 - - name: Integrations - url: /api/latest/integrations/ - identifier: integrations - generated: true - - name: List Integrations - url: '#list-integrations' - identifier: integrations-list-integrations - parent: integrations - generated: true - params: - versions: - - v2 - operationids: - - ListIntegrations - unstable: [] - order: 1 - name: Jira Integration url: /api/latest/jira-integration/ identifier: jira-integration @@ -12957,6 +12941,42 @@ menu: url: /api/latest/status-pages/ identifier: status-pages generated: true + - name: Update maintenance + url: '#update-maintenance' + identifier: status-pages-update-maintenance + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - UpdateMaintenance + unstable: [] + order: 17 + - name: Get maintenance + url: '#get-maintenance' + identifier: status-pages-get-maintenance + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - GetMaintenance + unstable: [] + order: 19 + - name: Create maintenance + url: '#create-maintenance' + identifier: status-pages-create-maintenance + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - CreateMaintenance + unstable: [] + order: 16 - name: Update degradation url: '#update-degradation' identifier: status-pages-update-degradation @@ -13101,6 +13121,18 @@ menu: - DeleteStatusPage unstable: [] order: 5 + - name: List maintenances + url: '#list-maintenances' + identifier: status-pages-list-maintenances + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - ListMaintenances + unstable: [] + order: 18 - name: List degradations url: '#list-degradations' identifier: status-pages-list-degradations diff --git a/content/en/api/v2/status-pages/examples.json b/content/en/api/v2/status-pages/examples.json index e54524183b3..d3603e4a4af 100644 --- a/content/en/api/v2/status-pages/examples.json +++ b/content/en/api/v2/status-pages/examples.json @@ -330,6 +330,115 @@ "html": "" } }, + "ListMaintenances": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "in_progress_description": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "published_date": "2019-09-19T10:00:00.000Z", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "status": "string", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "id": "string", + "manual_transition": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "string" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenances" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ], + "meta": { + "page": { + "first_offset": "integer", + "last_offset": "integer", + "limit": "integer", + "next_offset": "integer", + "offset": "integer", + "prev_offset": "integer", + "total": "integer", + "type": "string" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed,canceled

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n
\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "DeleteStatusPage": { "responses": { "429": { @@ -1294,5 +1403,354 @@ }, "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" } + }, + "CreateMaintenance": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "in_progress_description": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "published_date": "2019-09-19T10:00:00.000Z", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "status": "string", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "id": "string", + "manual_transition": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "string" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenances" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed,canceled

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "title": "API Maintenance" + }, + "type": "maintenances" + } + }, + "json": { + "data": { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "in_progress_description": "string", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "title": "API Maintenance" + }, + "type": "maintenances" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for creating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected [required]

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" + } + }, + "GetMaintenance": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "in_progress_description": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "published_date": "2019-09-19T10:00:00.000Z", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "status": "string", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "id": "string", + "manual_transition": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "string" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenances" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed,canceled

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateMaintenance": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "in_progress_description": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "published_date": "2019-09-19T10:00:00.000Z", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "status": "string", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "id": "string", + "manual_transition": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "string" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenances" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed,canceled

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n
\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n
\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ] + }, + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "maintenances" + } + }, + "json": { + "data": { + "attributes": { + "completed_date": "2019-09-19T10:00:00.000Z", + "completed_description": "string", + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "in_progress_description": "string", + "scheduled_description": "string", + "start_date": "2019-09-19T10:00:00.000Z", + "status": "string", + "title": "string" + }, + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "maintenances" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed,canceled

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" + } } } \ No newline at end of file diff --git a/content/en/api/v2/status-pages/request.CreateMaintenance.json b/content/en/api/v2/status-pages/request.CreateMaintenance.json new file mode 100644 index 00000000000..e9436261ca9 --- /dev/null +++ b/content/en/api/v2/status-pages/request.CreateMaintenance.json @@ -0,0 +1,19 @@ +{ + "data": { + "attributes": { + "title": "API Maintenance", + "scheduled_description": "We will be performing maintenance on the API to improve performance.", + "in_progress_description": "We are currently performing maintenance on the API to improve performance.", + "completed_description": "We have completed maintenance on the API to improve performance.", + "start_date": "2021-11-11T12:11:11+00:00", + "completed_date": "2021-11-11T13:11:11+00:00", + "components_affected": [ + { + "id": "4e9d3726-bdd7-0079-613c-e9aaba89eb01", + "status": "operational" + } + ] + }, + "type": "maintenances" + } +} \ No newline at end of file diff --git a/content/en/api/v2/status-pages/request.UpdateMaintenance.json b/content/en/api/v2/status-pages/request.UpdateMaintenance.json new file mode 100644 index 00000000000..b92ffa177b9 --- /dev/null +++ b/content/en/api/v2/status-pages/request.UpdateMaintenance.json @@ -0,0 +1,10 @@ +{ + "data": { + "attributes": { + "scheduled_description": "We will be performing maintenance on the API to improve performance for 40 minutes.", + "in_progress_description": "We are currently performing maintenance on the API to improve performance for 40 minutes." + }, + "id": "6a167dcd-4975-9fda-c895-ee008c4256f9", + "type": "maintenances" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index f5801b49ea7..42fa0266ad6 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -2028,6 +2028,13 @@ "description": "Create degradation returns \"Created\" response" } ], + "CreateMaintenance": [ + { + "group": "status_pages", + "suffix": "", + "description": "Create maintenance returns \"Created\" response" + } + ], "CreateStatusPage": [ { "group": "status_pages", @@ -2049,6 +2056,13 @@ "description": "Update degradation returns \"OK\" response" } ], + "UpdateMaintenance": [ + { + "group": "status_pages", + "suffix": "", + "description": "Update maintenance returns \"OK\" response" + } + ], "UpdateStatusPage": [ { "group": "status_pages", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 02963e661a5..2938ac6a660 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -15029,6 +15029,88 @@ components: - findings - project type: object + CreateMaintenanceRequest: + example: + data: + attributes: + completed_date: '2026-02-18T19:51:13.332360075Z' + completed_description: We have completed maintenance on the API to improve + performance. + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational + in_progress_description: We are currently performing maintenance on the + API to improve performance. + scheduled_description: We will be performing maintenance on the API to + improve performance. + start_date: '2026-02-18T19:21:13.332360075Z' + title: API Maintenance + id: 00000000-0000-0000-0000-000000000000 + type: maintenances + properties: + data: + $ref: '#/components/schemas/CreateMaintenanceRequestData' + type: object + CreateMaintenanceRequestData: + properties: + attributes: + $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributes' + type: + $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + required: + - attributes + - type + type: object + CreateMaintenanceRequestDataAttributes: + description: The supported attributes for creating a maintenance. + properties: + completed_date: + description: Timestamp of when the maintenance was completed. + format: date-time + type: string + completed_description: + description: The description shown when the maintenance is completed. + type: string + components_affected: + description: The components affected by the maintenance. + items: + $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems' + type: array + in_progress_description: + description: The description shown while the maintenance is in progress. + type: string + scheduled_description: + description: The description shown when the maintenance is scheduled. + type: string + start_date: + description: Timestamp of when the maintenance is scheduled to start. + format: date-time + type: string + title: + description: The title of the maintenance. + example: API Maintenance + type: string + required: + - components_affected + - title + type: object + CreateMaintenanceRequestDataAttributesComponentsAffectedItems: + properties: + id: + description: The ID of the component. Must be a component of type `component`. + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + required: + - id + - status + type: object CreateNotificationChannelAttributes: description: Attributes for creating an on-call notification channel. properties: @@ -19665,7 +19747,7 @@ components: description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationArrayIncluded' + $ref: '#/components/schemas/DegradationIncluded' type: array type: object DegradationArray: @@ -19678,17 +19760,13 @@ components: description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationArrayIncluded' + $ref: '#/components/schemas/DegradationIncluded' type: array meta: $ref: '#/components/schemas/StatusPagesResponseMeta' required: - data type: object - DegradationArrayIncluded: - oneOf: - - $ref: '#/components/schemas/StatusPagesUser' - - $ref: '#/components/schemas/StatusPageAsIncluded' DegradationData: properties: attributes: @@ -19868,6 +19946,10 @@ components: - type - id type: object + DegradationIncluded: + oneOf: + - $ref: '#/components/schemas/StatusPagesUser' + - $ref: '#/components/schemas/StatusPageAsIncluded' DeleteAppResponse: description: The response object after an app is successfully deleted. properties: @@ -32171,53 +32253,6 @@ components: type: string type: array type: object - Integration: - description: Integration resource object. - properties: - attributes: - $ref: '#/components/schemas/IntegrationAttributes' - id: - description: The unique identifier of the integration. - example: calico - type: string - links: - $ref: '#/components/schemas/IntegrationLinks' - type: - $ref: '#/components/schemas/IntegrationType' - required: - - type - - id - - attributes - type: object - IntegrationAttributes: - description: Attributes for an integration. - properties: - categories: - description: List of categories associated with the integration. - example: - - Category::Kubernetes - - Category::Log Collection - items: - type: string - type: array - description: - description: A description of the integration. - example: Calico is a networking and network security solution for containers. - type: string - installed: - description: Whether the integration is installed. - example: true - type: boolean - title: - description: The name of the integration. - example: calico - type: string - required: - - title - - description - - categories - - installed - type: object IntegrationIncident: description: Incident integration settings properties: @@ -32323,14 +32358,6 @@ components: value: $ref: '#/components/schemas/AnyValue' type: object - IntegrationLinks: - description: Links for the integration resource. - properties: - self: - description: Link to the integration resource. - example: /integrations?integrationId=calico - type: string - type: object IntegrationMonitor: description: Monitor integration settings properties: @@ -32432,15 +32459,6 @@ components: type: string type: object type: object - IntegrationType: - default: integration - description: Integration resource type. - enum: - - integration - example: integration - type: string - x-enum-varnames: - - INTEGRATION InterfaceAttributes: description: The interface attributes properties: @@ -35074,17 +35092,6 @@ components: - data - meta type: object - ListIntegrationsResponse: - description: Response containing information about multiple integrations. - properties: - data: - description: Array of integration objects. - items: - $ref: '#/components/schemas/Integration' - type: array - required: - - data - type: object ListInterfaceTagsResponse: description: Response for listing interface tags. properties: @@ -36561,6 +36568,248 @@ components: - ms_channel_name - redirect_url type: object + Maintenance: + properties: + data: + $ref: '#/components/schemas/MaintenanceData' + included: + description: The included related resources of a maintenance. Client must + explicitly request these resources by name in the `include` query parameter. + items: + $ref: '#/components/schemas/DegradationIncluded' + type: array + type: object + MaintenanceArray: + properties: + data: + items: + $ref: '#/components/schemas/MaintenanceData' + type: array + included: + description: The included related resources of a maintenance. Client must + explicitly request these resources by name in the `include` query parameter. + items: + $ref: '#/components/schemas/DegradationIncluded' + type: array + meta: + $ref: '#/components/schemas/PaginationMeta' + required: + - data + type: object + MaintenanceData: + properties: + attributes: + $ref: '#/components/schemas/MaintenanceDataAttributes' + id: + description: The ID of the maintenance. + format: uuid + type: string + relationships: + $ref: '#/components/schemas/MaintenanceDataRelationships' + type: + $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + required: + - type + type: object + MaintenanceDataAttributes: + description: The attributes of a maintenance. + properties: + completed_date: + description: Timestamp of when the maintenance was completed. + format: date-time + type: string + completed_description: + description: The description shown when the maintenance is completed. + type: string + components_affected: + description: Components affected by the maintenance. + items: + $ref: '#/components/schemas/MaintenanceDataAttributesComponentsAffectedItems' + type: array + in_progress_description: + description: The description shown while the maintenance is in progress. + type: string + modified_at: + description: Timestamp of when the maintenance was last modified. + format: date-time + type: string + published_date: + description: Timestamp of when the maintenance was published. + format: date-time + type: string + scheduled_description: + description: The description shown when the maintenance is scheduled. + type: string + start_date: + description: Timestamp of when the maintenance is scheduled to start. + format: date-time + type: string + status: + $ref: '#/components/schemas/MaintenanceDataAttributesStatus' + description: The status of the maintenance. + title: + description: Title of the maintenance. + type: string + updates: + description: Past updates made to the maintenance. + items: + $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItems' + type: array + type: object + MaintenanceDataAttributesComponentsAffectedItems: + properties: + id: + description: The ID of the component. Must be a component of type `component`. + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + required: + - id + - status + type: object + MaintenanceDataAttributesStatus: + description: The status of the maintenance. + enum: + - scheduled + - in_progress + - completed + - canceled + type: string + x-enum-varnames: + - SCHEDULED + - IN_PROGRESS + - COMPLETED + - CANCELED + MaintenanceDataAttributesUpdatesItems: + properties: + components_affected: + description: The components affected at the time of the update. + items: + $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems' + type: array + created_at: + description: Timestamp of when the update was created. + format: date-time + readOnly: true + type: string + description: + description: Description of the update. + type: string + id: + description: Identifier of the update. + format: uuid + readOnly: true + type: string + manual_transition: + readOnly: true + type: boolean + modified_at: + description: Timestamp of when the update was last modified. + format: date-time + readOnly: true + type: string + started_at: + description: Timestamp of when the update started. + format: date-time + type: string + status: + description: The status of the update. + type: string + type: object + MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems: + properties: + id: + description: Identifier of the component affected at the time of the update. + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + name: + description: The name of the component affected at the time of the update. + readOnly: true + type: string + status: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + description: The status of the component affected at the time of the update. + required: + - id + - status + type: object + MaintenanceDataRelationships: + description: The relationships of a maintenance. + properties: + created_by_user: + $ref: '#/components/schemas/MaintenanceDataRelationshipsCreatedByUser' + description: The Datadog user who created the maintenance. + last_modified_by_user: + $ref: '#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUser' + description: The Datadog user who last modified the maintenance. + status_page: + $ref: '#/components/schemas/MaintenanceDataRelationshipsStatusPage' + description: The status page the maintenance belongs to. + type: object + MaintenanceDataRelationshipsCreatedByUser: + properties: + data: + $ref: '#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData' + required: + - data + type: object + MaintenanceDataRelationshipsCreatedByUserData: + properties: + id: + example: '' + format: uuid + type: string + type: + $ref: '#/components/schemas/StatusPagesUserType' + required: + - type + - id + type: object + MaintenanceDataRelationshipsLastModifiedByUser: + properties: + data: + $ref: '#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData' + required: + - data + type: object + MaintenanceDataRelationshipsLastModifiedByUserData: + properties: + id: + example: '' + format: uuid + type: string + type: + $ref: '#/components/schemas/StatusPagesUserType' + required: + - type + - id + type: object + MaintenanceDataRelationshipsStatusPage: + properties: + data: + $ref: '#/components/schemas/MaintenanceDataRelationshipsStatusPageData' + required: + - data + type: object + MaintenanceDataRelationshipsStatusPageData: + properties: + id: + example: '' + format: uuid + type: string + type: + $ref: '#/components/schemas/StatusPageDataType' + required: + - type + - id + type: object MemberTeam: description: A member team properties: @@ -46090,6 +46339,41 @@ components: format: int64 type: integer type: object + PaginationMeta: + properties: + page: + $ref: '#/components/schemas/PaginationMetaPage' + type: object + PaginationMetaPage: + properties: + first_offset: + format: int64 + type: integer + last_offset: + format: int64 + nullable: true + type: integer + limit: + format: int64 + type: integer + next_offset: + format: int64 + nullable: true + type: integer + offset: + format: int64 + type: integer + prev_offset: + format: int64 + nullable: true + type: integer + total: + format: int64 + nullable: true + type: integer + type: + type: string + type: object Parameter: description: The definition of `Parameter` object. properties: @@ -46397,6 +46681,107 @@ components: required: - data type: object + PatchMaintenanceRequest: + example: + data: + attributes: + completed_date: '2026-02-18T20:01:13.332360075Z' + in_progress_description: We are currently performing maintenance on the + API to improve performance for 40 minutes. + scheduled_description: We will be performing maintenance on the API to + improve performance for 40 minutes. + start_date: '2026-02-18T19:21:13.332360075Z' + title: null + id: 00000000-0000-0000-0000-000000000000 + type: maintenances + properties: + data: + $ref: '#/components/schemas/PatchMaintenanceRequestData' + type: object + PatchMaintenanceRequestData: + properties: + attributes: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributes' + id: + description: The ID of the maintenance. + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + type: + $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + required: + - attributes + - type + - id + type: object + PatchMaintenanceRequestDataAttributes: + description: The supported attributes for updating a maintenance. + properties: + completed_date: + description: Timestamp of when the maintenance was completed. + format: date-time + type: string + completed_description: + description: The description shown when the maintenance is completed. + type: string + components_affected: + description: The components affected by the maintenance. + items: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItems' + type: array + in_progress_description: + description: The description shown while the maintenance is in progress. + type: string + scheduled_description: + description: The description shown when the maintenance is scheduled. + type: string + start_date: + description: Timestamp of when the maintenance is scheduled to start. + format: date-time + type: string + status: + $ref: '#/components/schemas/MaintenanceDataAttributesStatus' + description: The status of the maintenance. + title: + description: The title of the maintenance. + type: string + type: object + PatchMaintenanceRequestDataAttributesComponentsAffectedItems: + properties: + id: + description: The ID of the component. Must be a component of type `component`. + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + required: + - id + - status + type: object + PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus: + description: The status of the component. + enum: + - operational + - maintenance + example: operational + type: string + x-enum-varnames: + - OPERATIONAL + - MAINTENANCE + PatchMaintenanceRequestDataType: + default: maintenances + description: Maintenances resource type. + enum: + - maintenances + example: maintenances + type: string + x-enum-varnames: + - MAINTENANCES PatchNotificationRuleParameters: description: Body of the notification rule patch request. properties: @@ -84698,25 +85083,6 @@ paths: x-unstable: '**Note**: This endpoint is in public beta and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' - /api/v2/integrations: - get: - operationId: ListIntegrations - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ListIntegrationsResponse' - description: Successful Response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - summary: List Integrations - tags: - - Integrations - x-menu-order: 1 /api/v2/integrations/cloudflare/accounts: get: description: List Cloudflare accounts. @@ -102757,6 +103123,12 @@ paths: name: filter[status] schema: type: string + - description: 'Sort order. Prefix with ''-'' for descending. Supported values: + created_at, -created_at, modified_at, -modified_at.' + in: query + name: sort + schema: + type: string responses: '200': content: @@ -102778,6 +103150,68 @@ paths: operator: AND permissions: - status_pages_settings_read + /api/v2/statuspages/maintenances: + get: + description: Lists all maintenances for the organization. Optionally filter + by status and page. + operationId: ListMaintenances + parameters: + - description: Optional page id filter. + in: query + name: filter[page_id] + schema: + type: string + - description: Offset to use as the start of the page. + in: query + name: page[offset] + schema: + default: 0 + type: integer + - description: The number of maintenances to return per page. + in: query + name: page[limit] + schema: + default: 50 + type: integer + - description: 'Comma-separated list of resources to include. Supported values: + created_by_user, last_modified_by_user, status_page.' + in: query + name: include + schema: + type: string + - description: 'Optional maintenance status filter. Supported values: scheduled, + in_progress, completed, canceled.' + in: query + name: filter[status] + schema: + type: string + - description: 'Sort order. Prefix with ''-'' for descending. Supported values: + created_at, -created_at, start_date, -start_date.' + in: query + name: sort + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceArray' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: List maintenances + tags: + - Status Pages + x-menu-order: 18 + x-permission: + operator: AND + permissions: + - status_pages_settings_read /api/v2/statuspages/{page_id}: delete: description: Deletes a status page by its ID. @@ -103318,6 +103752,160 @@ paths: operator: AND permissions: - status_pages_incident_write + /api/v2/statuspages/{page_id}/maintenances: + post: + description: Creates a new maintenance. + operationId: CreateMaintenance + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: Whether to notify page subscribers of the maintenance. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: 'Comma-separated list of resources to include. Supported values: + created_by_user, last_modified_by_user, status_page.' + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMaintenanceRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Maintenance' + description: Created + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Create maintenance + tags: + - Status Pages + x-menu-order: 16 + x-permission: + operator: AND + permissions: + - status_pages_incident_write + /api/v2/statuspages/{page_id}/maintenances/{maintenance_id}: + get: + description: Retrieves a specific maintenance by its ID. + operationId: GetMaintenance + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the maintenance. + in: path + name: maintenance_id + required: true + schema: + format: uuid + type: string + - description: 'Comma-separated list of resources to include. Supported values: + created_by_user, last_modified_by_user, status_page.' + in: query + name: include + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Maintenance' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get maintenance + tags: + - Status Pages + x-menu-order: 19 + x-permission: + operator: AND + permissions: + - status_pages_settings_read + patch: + description: Updates an existing maintenance's attributes. + operationId: UpdateMaintenance + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: Whether to notify page subscribers of the maintenance. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: The ID of the maintenance. + in: path + name: maintenance_id + required: true + schema: + format: uuid + type: string + - description: 'Comma-separated list of resources to include. Supported values: + created_by_user, last_modified_by_user, status_page.' + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchMaintenanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Maintenance' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Update maintenance + tags: + - Status Pages + x-menu-order: 17 + x-permission: + operator: AND + permissions: + - status_pages_incident_write /api/v2/synthetics/settings/on_demand_concurrency_cap: get: description: Get the on-demand concurrency cap. @@ -107857,10 +108445,6 @@ tags: and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information. name: Incidents -- description: 'The Integrations API is used to list available integrations - - and retrieve information about their installation status.' - name: Integrations - description: Manage your Jira Integration. Atlassian Jira is a project management and issue tracking tool for teams to coordinate work and handle tasks efficiently. name: Jira Integration diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d35265f57f4..2d59faec1b8 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1736,9 +1736,6 @@ "description": "Get all users for a ServiceNow instance.", "summary": "List ServiceNow users" }, - "ListIntegrations": { - "summary": "List Integrations" - }, "ListCloudflareAccounts": { "description": "List Cloudflare accounts.", "summary": "List Cloudflare accounts" @@ -3717,6 +3714,10 @@ "description": "Lists all degradations for the organization. Optionally filter by status and page.", "summary": "List degradations" }, + "ListMaintenances": { + "description": "Lists all maintenances for the organization. Optionally filter by status and page.", + "summary": "List maintenances" + }, "DeleteStatusPage": { "description": "Deletes a status page by its ID.", "summary": "Delete status page" @@ -3775,6 +3776,22 @@ "request_description": "", "request_schema_description": "" }, + "CreateMaintenance": { + "description": "Creates a new maintenance.", + "summary": "Create maintenance", + "request_description": "", + "request_schema_description": "" + }, + "GetMaintenance": { + "description": "Retrieves a specific maintenance by its ID.", + "summary": "Get maintenance" + }, + "UpdateMaintenance": { + "description": "Updates an existing maintenance's attributes.", + "summary": "Update maintenance", + "request_description": "", + "request_schema_description": "" + }, "GetOnDemandConcurrencyCap": { "description": "Get the on-demand concurrency cap.", "summary": "Get the on-demand concurrency cap" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index f4a9e800c44..df2b7c51957 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -183,10 +183,6 @@ "name": "Incidents", "description": "Manage incident response, as well as associated attachments, metadata, and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information." }, - "integrations": { - "name": "Integrations", - "description": "The Integrations API is used to list available integrations\nand retrieve information about their installation status." - }, "jira-integration": { "name": "Jira Integration", "description": "Manage your Jira Integration. Atlassian Jira is a project management and issue tracking tool for teams to coordinate work and handle tasks efficiently."