openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Projects API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Projects
paths:
/api/v2/cases/projects:
get:
description: Get all projects.
operationId: GetProjects
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cases_read
summary: Datadog Get All Projects
tags:
- Projects
x-menu-order: 2
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
description: Create a project.
operationId: CreateProject
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreateRequest'
description: Project payload
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
description: CREATED
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cases_write
summary: Datadog Create a Project
tags:
- Projects
x-menu-order: 1
x-undo:
operationId: DeleteProject
parameters:
- name: project_id
source: data.id
type: unsafe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/projects/{project_id}:
delete:
description: Remove a project using the project's `id`.
operationId: DeleteProject
parameters:
- $ref: '#/components/parameters/ProjectIDPathParameter'
responses:
'204':
description: No Content
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cases_write
summary: Datadog Remove a Project
tags:
- Projects
x-menu-order: 4
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
description: Get the details of a project by `project_id`.
operationId: GetProject
parameters:
- $ref: '#/components/parameters/ProjectIDPathParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cases_read
summary: Datadog Get the Details of a Project
tags:
- Projects
x-menu-order: 3
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
Project:
description: A Project
properties:
attributes:
$ref: '#/components/schemas/ProjectAttributes'
id:
description: The Project's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
$ref: '#/components/schemas/ProjectRelationships'
type:
$ref: '#/components/schemas/ProjectResourceType'
required:
- id
- type
- attributes
type: object
ProjectsResponse:
description: Response with projects
properties:
data:
description: Projects response data
items:
$ref: '#/components/schemas/Project'
type: array
type: object
ProjectResourceType:
default: project
description: Project resource type
enum:
- project
example: project
type: string
x-enum-varnames:
- PROJECT
TeamLinkType:
default: team_links
description: Team link type
enum:
- team_links
example: team_links
type: string
x-enum-varnames:
- TEAM_LINKS
ProjectCreateRequest:
description: Project create request
properties:
data:
$ref: '#/components/schemas/ProjectCreate'
required:
- data
type: object
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
UsersRelationship:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/UserRelationshipData'
type: array
required:
- data
type: object
TeamRelationshipsLinks:
description: Links attributes.
properties:
related:
description: Related link.
example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
type: string
type: object
ProjectResponse:
description: Project response
properties:
data:
$ref: '#/components/schemas/Project'
type: object
RelationshipToTeamLinks:
description: Relationship between a team and a team link
properties:
data:
description: Related team links
items:
$ref: '#/components/schemas/RelationshipToTeamLinkData'
type: array
links:
$ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
x-merge-override:
required: false
ProjectAttributes:
description: Project attributes
properties:
key:
description: The project's key
example: CASEM
type: string
name:
description: Project's name
type: string
example: Example Monitor
type: object
UserResourceType:
default: user
description: User resource type.
enum:
- user
example: user
type: string
x-enum-varnames:
- USER
ProjectCreateAttributes:
description: Project creation attributes
properties:
key:
description: Project's key. Cannot be "CASE"
example: SEC
type: string
name:
description: name
example: Security Investigation
type: string
required:
- name
- key
type: object
UserRelationshipData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UserResourceType'
required:
- id
- type
type: object
ProjectCreate:
description: Project create
properties:
attributes:
$ref: '#/components/schemas/ProjectCreateAttributes'
type:
$ref: '#/components/schemas/ProjectResourceType'
required:
- attributes
- type
type: object
RelationshipToTeamLinkData:
description: Relationship between a link and a team
properties:
id:
description: The team link's identifier
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
$ref: '#/components/schemas/TeamLinkType'
required:
- id
- type
type: object
x-merge-override:
required: false
ProjectRelationships:
description: Project relationships
properties:
member_team:
$ref: '#/components/schemas/RelationshipToTeamLinks'
member_user:
$ref: '#/components/schemas/UsersRelationship'
type: object
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
UnauthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
parameters:
ProjectIDPathParameter:
description: Project UUID
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
in: path
name: project_id
required: true
schema:
type: string
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false