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 Remove 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: Remove
paths:
/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:
- Remove
x-menu-order: 4
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/roles/{role_id}/users:
delete:
description: Removes a user from a role.
operationId: RemoveUserFromRole
parameters:
- $ref: '#/components/parameters/RoleID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RelationshipToUser'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UsersResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- user_access_manage
summary: Datadog Remove a User from a Role
tags:
- Remove
x-codegen-request-body-name: body
x-menu-order: 11
x-permission:
operator: OR
permissions:
- user_access_manage
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/team/{team_id}:
x-merge-override:
delete: true
get: false
patch: false
delete:
description: Remove a team using the team's `id`.
operationId: DeleteTeam
parameters:
- description: None
in: path
name: team_id
required: true
schema:
type: string
example: abc-123-def
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:
- teams_read
- teams_manage
summary: Datadog Remove a Team
tags:
- Remove
x-menu-order: 5
x-permission:
operator: AND
permissions:
- teams_read
- teams_manage
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/team/{team_id}/links/{link_id}:
delete:
description: Remove a link from a team.
operationId: DeleteTeamLink
parameters:
- description: None
in: path
name: team_id
required: true
schema:
type: string
example: abc-123-def
- description: None
in: path
name: link_id
required: true
schema:
type: string
example: abc-123-def
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:
- teams_read
summary: Datadog Remove a Team Link
tags:
- Remove
x-menu-order: 14
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/team/{team_id}/memberships/{user_id}:
x-merge-override:
delete: true
delete:
description: Remove a user from a team.
operationId: DeleteTeamMembership
parameters:
- description: None
in: path
name: team_id
required: true
schema:
type: string
example: abc-123-def
- description: None
in: path
name: user_id
required: true
schema:
type: string
example: abc-123-def
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:
- teams_read
summary: Datadog Remove a User from a Team
tags:
- Remove
x-menu-order: 8
x-permission:
operator: OR
permissions:
- teams_read
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RelationshipToUserData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
required:
- id
- type
type: object
x-merge-override:
required: false
UsersType:
default: users
description: Users resource type.
enum:
- users
example: users
type: string
x-enum-varnames:
- USERS
PermissionsType:
default: permissions
description: Permissions resource type.
enum:
- permissions
example: permissions
type: string
x-enum-varnames:
- PERMISSIONS
RelationshipToRoles:
description: Relationship to roles.
properties:
data:
description: An array containing type and the unique identifier of a role.
items:
$ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
x-merge-override:
required: false
UsersResponse:
description: Response containing information about multiple users.
properties:
data:
description: Array of returned users.
items:
$ref: '#/components/schemas/User'
type: array
included:
description: Array of objects related to the users.
items:
$ref: '#/components/schemas/UserResponseIncludedItem'
type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
readOnly: true
type: object
OrganizationAttributes:
description: Attributes of the organization.
properties:
created_at:
description: Creation time of the organization.
format: date-time
type: string
example: example_value
description:
description: Description of the organization.
type: string
example: example_value
disabled:
description: Whether or not the organization is disabled.
type: boolean
example: true
modified_at:
description: Time of last organization modification.
format: date-time
type: string
example: example_value
name:
description: Name of the organization.
type: string
example: Example Monitor
public_id:
description: Public ID of the organization.
type: string
example: abc-123-def
sharing:
description: Sharing type of the organization.
type: string
example: example_value
url:
description: URL of the site that this organization exists at.
type: string
example: https://app.datadoghq.com
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
UserResponseRelationships:
description: Relationships of the user object returned by the API.
properties:
org:
$ref: '#/components/schemas/RelationshipToOrganization'
other_orgs:
$ref: '#/components/schemas/RelationshipToOrganizations'
other_users:
$ref: '#/components/schemas/RelationshipToUsers'
roles:
$ref: '#/components/schemas/RelationshipToRoles'
type: object
x-merge-override:
properties: false
RelationshipToOrganizations:
description: Relationship to organizations.
properties:
data:
description: Relationships to organization objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
type: object
UserAttributes:
description: Attributes of user object returned by the API.
properties:
created_at:
description: Creation time of the user.
format: date-time
type: string
example: example_value
disabled:
description: Whether the user is disabled.
type: boolean
example: true
email:
description: Email of the user.
type: string
example: user@example.com
handle:
description: Handle of the user.
type: string
example: example_value
icon:
description: URL of the user's icon.
type: string
example: example_value
mfa_enabled:
description: If user has MFA enabled.
readOnly: true
type: boolean
example: true
modified_at:
description: Time that the user was last modified.
format: date-time
type: string
example: example_value
name:
description: Name of the user.
nullable: true
type: string
example: Example Monitor
service_account:
description: Whether the user is a service account.
type: boolean
example: true
status:
description: Status of the user.
type: string
example: OK
title:
description: Title of the user.
nullable: true
type: string
example: Example Monitor
verified:
description: Whether the user is verified.
type: boolean
example: true
type: object
Pagination:
description: Pagination object.
properties:
total_count:
description: Total count.
format: int64
type: integer
example: 42
total_filtered_count:
description: Total count of elements matched by the filter.
format: int64
type: integer
example: 42
type: object
PermissionAttributes:
description: Attributes of a permission.
properties:
created:
description: Creation time of the permission.
format: date-time
type: string
example: example_value
description:
description: Description of the permission.
type: string
example: example_value
display_name:
description: Displayed name for the permission.
type: string
example: Example Monitor
display_type:
description: Display type.
type: string
example: metric alert
group_name:
description: Name of the permission group.
type: string
example: Example Monitor
name:
description: Name of the permission.
type: string
example: Example Monitor
restricted:
description: Whether or not the permission is restricted.
type: boolean
example: true
type: object
RoleResponseRelationships:
description: Relationships of the role object returned by the API.
properties:
permissions:
$ref: '#/components/schemas/RelationshipToPermissions'
type: object
UserResponseIncludedItem:
description: An object related to a user.
oneOf:
- $ref: '#/components/schemas/Organization'
- $ref: '#/components/schemas/Permission'
- $ref: '#/components/schemas/Role'
RoleAttributes:
description: Attributes of the role.
properties:
created_at:
description: Creation time of the role.
format: date-time
readOnly: true
type: string
example: example_value
modified_at:
description: Time of last role modification.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: The name of the role. The name is neither unique nor a stable identifier of the role.
type: string
example: Example Monitor
user_count:
description: Number of users with that role.
format: int64
readOnly: true
type: integer
example: 42
type: object
Permission:
description: Permission object.
properties:
attributes:
$ref: '#/components/schemas/PermissionAttributes'
id:
description: ID of the permission.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/PermissionsType'
required:
- type
type: object
RelationshipToRoleData:
description: Relationship to role object.
properties:
id:
description: The unique identifier of the role.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
type:
$ref: '#/components/schemas/RolesType'
type: object
x-merge-override:
required: false
ResponseMetaAttributes:
description: Object describing meta attributes of response.
properties:
page:
$ref: '#/components/schemas/Pagination'
type: object
x-merge-override:
properties: false
User:
description: User object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/UserAttributes'
id:
description: ID of the user.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/UserResponseRelationships'
type:
$ref: '#/components/schemas/UsersType'
type: object
x-merge-override:
required: false
RelationshipToOrganizationData:
description: Relationship to organization object.
properties:
id:
description: ID of the organization.
example: 00000000-0000-beef-0000-000000000000
type: string
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- id
- type
type: object
Organization:
description: Organization object.
properties:
attributes:
$ref: '#/components/schemas/OrganizationAttributes'
id:
description: ID of the organization.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- type
type: object
RelationshipToUser:
description: Relationship to user.
properties:
data:
$ref: '#/components/schemas/RelationshipToUserData'
required:
- data
type: object
Role:
description: Role object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/RoleAttributes'
id:
description: The unique identifier of the role.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/RoleResponseRelationships'
type:
$ref: '#/components/schemas/RolesType'
required:
- type
type: object
x-merge-override:
required: false
RolesType:
default: roles
description: Roles type.
enum:
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
OrganizationsType:
default: orgs
description: Organizations resource type.
enum:
- orgs
example: orgs
type: string
x-enum-varnames:
- ORGS
RelationshipToUsers:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
type: object
RelationshipToPermissions:
description: Relationship to multiple permissions objects.
properties:
data:
description: Relationships to permission objects.
items:
$ref: '#/components/schemas/RelationshipToPermissionData'
type: array
type: object
x-merge-override:
required: false
RelationshipToOrganization:
description: Relationship to an organization.
properties:
data:
$ref: '#/components/schemas/RelationshipToOrganizationData'
required:
- data
type: object
RelationshipToPermissionData:
description: Relationship to permission object.
properties:
id:
description: ID of the permission.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/PermissionsType'
type: object
x-merge-override:
required: false
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
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
RoleID:
description: The unique identifier of the role.
in: path
name: role_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