.generator/schemas/v2/openapi.yaml in datadog_api_client-2.25.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.26.0

- old
+ new

@@ -200,10 +200,18 @@ in: path name: custom_destination_id required: true schema: type: string + EntityID: + description: UUID or Entity Ref + in: path + name: entity_id + required: true + schema: + example: service:myservice + type: string FastlyAccountID: description: Fastly Account id. in: path name: account_id required: true @@ -221,10 +229,65 @@ in: path name: file_id required: true schema: type: string + FilterByExcludeSnapshot: + description: Filter entities by excluding snapshotted entities + in: query + name: fitler[exclude_snapshot] + required: false + schema: + type: string + FilterByID: + description: Filter entities by UUID + explode: true + in: query + name: fitler[id] + required: false + schema: + type: string + FilterByKind: + description: Filter entities by kind + explode: true + in: query + name: fitler[kind] + required: false + schema: + type: string + FilterByName: + description: Filter entities by name + explode: true + in: query + name: fitler[name] + required: false + schema: + type: string + FilterByOwner: + description: Filter entities by owner + explode: true + in: query + name: fitler[owner] + required: false + schema: + type: string + FilterByRef: + description: Filter entities by reference + explode: true + in: query + name: fitler[ref] + required: false + schema: + type: string + FilterByRelationType: + description: Filter entities by relation type + explode: true + in: query + name: fitler[relation][type] + required: false + schema: + $ref: '#/components/schemas/RelationType' GCPSTSServiceAccountID: description: Your GCP STS enabled service account's unique ID. in: path name: account_id required: true @@ -356,10 +419,18 @@ in: path name: todo_id required: true schema: type: string + Include: + description: include relationship data + explode: true + in: query + name: include + required: false + schema: + $ref: '#/components/schemas/IncludeType' InstanceId: description: The ID of the workflow instance. in: path name: instance_id required: true @@ -660,10 +731,12 @@ 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 @@ -671,14 +744,20 @@ - errors type: object APIKeyCreateAttributes: description: Attributes used to create an API Key. properties: + category: + description: The APIKeyCreateAttributes category. + type: string name: description: Name of the API key. example: API Key for submitting metrics type: string + remote_config_read_enabled: + description: The APIKeyCreateAttributes remote_config_read_enabled. + type: boolean required: - name type: object APIKeyCreateData: description: Object used to create an API key. @@ -720,17 +799,24 @@ type: object APIKeyResponseIncludedItem: description: An object related to an API key. oneOf: - $ref: '#/components/schemas/User' + - $ref: '#/components/schemas/LeakedKey' APIKeyUpdateAttributes: description: Attributes used to update an API Key. properties: + category: + description: The APIKeyUpdateAttributes category. + type: string name: description: Name of the API key. example: API Key for submitting metrics type: string + remote_config_read_enabled: + description: The APIKeyUpdateAttributes remote_config_read_enabled. + type: boolean required: - name type: object APIKeyUpdateData: description: Object used to update an API key. @@ -979,10 +1065,11 @@ ApplicationKeyResponseIncludedItem: description: An object related to an application key. oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/Role' + - $ref: '#/components/schemas/LeakedKey' ApplicationKeyResponseMeta: description: Additional information related to the application key response. properties: max_allowed_per_user: description: Max allowed number of application keys per user. @@ -2366,11 +2453,10 @@ nullable: true properties: author_email: description: The commit author email. example: author@example.com - format: email type: string author_name: description: The commit author name. example: John Doe nullable: true @@ -2391,11 +2477,10 @@ nullable: true type: string committer_email: description: The committer email. example: committer@example.com - format: email nullable: true type: string committer_name: description: The committer name. nullable: true @@ -4482,10 +4567,13 @@ email: description: The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required. example: test-email@example.com type: string + name: + description: The name of the Cloudflare account. + type: string resources: description: An allowlist of resources to restrict pulling metrics for. example: - web - dns @@ -5877,11 +5965,10 @@ description: A custom destination's location to forward logs. oneOf: - $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp' - $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk' - $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch' - type: object CustomDestinationForwardDestinationElasticsearch: description: The Elasticsearch destination. properties: auth: $ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth' @@ -5998,11 +6085,10 @@ CustomDestinationHttpDestinationAuth: description: Authentication method of the HTTP requests. oneOf: - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic' - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader' - type: object CustomDestinationHttpDestinationAuthBasic: description: Basic access authentication. properties: password: description: The password of the authentication. This field is not returned @@ -6138,11 +6224,10 @@ description: A custom destination's location to forward logs. oneOf: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp' - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk' - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch' - type: object CustomDestinationResponseForwardDestinationElasticsearch: description: The Elasticsearch destination. properties: auth: $ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth' @@ -6252,11 +6337,10 @@ CustomDestinationResponseHttpDestinationAuth: description: Authentication method of the HTTP requests. oneOf: - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic' - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader' - type: object CustomDestinationResponseHttpDestinationAuthBasic: description: Basic access authentication. properties: type: $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType' @@ -6406,11 +6490,11 @@ $ref: '#/components/schemas/DORAGitInfo' id: description: Deployment ID. type: string service: - description: Service name from a service available in the Service Catalog. + description: Service name. example: shopist type: string started_at: description: Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds. @@ -7536,10 +7620,818 @@ required: - id - type - attributes type: object + EntityAttributes: + description: Entity attributes. + properties: + apiVersion: + description: The api version. + type: string + description: + description: The description. + type: string + displayName: + description: The display name. + type: string + kind: + description: The kind. + type: string + name: + description: The name. + type: string + namespace: + description: The namespace. + type: string + owner: + description: The owner. + type: string + tags: + description: The tags. + items: + type: string + type: array + type: object + EntityData: + description: Entity data. + properties: + attributes: + $ref: '#/components/schemas/EntityAttributes' + id: + description: Entity id. + type: string + meta: + $ref: '#/components/schemas/EntityMeta' + relationships: + $ref: '#/components/schemas/EntityRelationships' + type: + description: Entity. + type: string + type: object + EntityMeta: + description: Entity metadata. + properties: + createdAt: + description: The creation time. + type: string + ingestionSource: + description: The ingestion source. + type: string + modifiedAt: + description: The modification time. + type: string + origin: + description: The origin. + type: string + type: object + EntityRaw: + description: Entity definition in raw JSON/YAML representation. + example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice\n" + type: string + EntityRelationships: + description: Entity relationships. + properties: + incidents: + $ref: '#/components/schemas/EntityToIncidents' + oncall: + $ref: '#/components/schemas/EntityToOncalls' + rawSchema: + $ref: '#/components/schemas/EntityToRawSchema' + relatedEntities: + $ref: '#/components/schemas/EntityToRelatedEntities' + schema: + $ref: '#/components/schemas/EntityToSchema' + type: object + EntityResponseData: + description: List of entity data. + items: + $ref: '#/components/schemas/EntityData' + type: array + EntityResponseIncludedIncident: + description: Included incident. + properties: + attributes: + $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes' + id: + description: Incident id. + type: string + type: + description: Incident description. + type: string + type: object + EntityResponseIncludedOncall: + description: Included oncall. + properties: + attributes: + $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallAttributes' + id: + description: Oncall ID. + type: string + type: + description: Oncall type. + type: string + type: object + EntityResponseIncludedRawSchema: + description: Included raw schema. + properties: + attributes: + $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes' + id: + description: Raw schema id. + type: string + type: + description: Raw schema type. + type: string + type: object + EntityResponseIncludedRawSchemaAttributes: + description: Included raw schema attributes. + properties: + rawSchema: + description: Schema from user input in base64 encoding. + type: string + type: object + EntityResponseIncludedRelatedEntity: + description: Included related entity. + properties: + attributes: + $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityAttributes' + id: + description: Entity UUID. + type: string + meta: + $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta' + type: + description: Related entity. + type: string + type: object + EntityResponseIncludedRelatedEntityAttributes: + description: Related entity attributes. + properties: + kind: + description: Entity kind. + type: string + name: + description: Entity name. + type: string + namespace: + description: Entity namespace. + type: string + type: + description: Entity relation type to the associated entity. + type: string + type: object + EntityResponseIncludedRelatedEntityMeta: + description: Included related entity meta. + properties: + createdAt: + description: Entity creation time. + format: date-time + type: string + defined_by: + description: Entity relation defined by. + type: string + modifiedAt: + description: Entity modification time. + format: date-time + type: string + source: + description: Entity relation source. + type: string + type: object + EntityResponseIncludedRelatedIncidentAttributes: + description: Incident attributes. + properties: + createdAt: + description: Incident creation time. + format: date-time + type: string + htmlURL: + description: Incident URL. + type: string + provider: + description: Incident provider. + type: string + status: + description: Incident status. + type: string + title: + description: Incident title. + type: string + type: object + EntityResponseIncludedRelatedOncallAttributes: + description: Included related oncall attributes. + properties: + escalations: + $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalations' + provider: + description: Oncall provider. + type: string + type: object + EntityResponseIncludedRelatedOncallEscalationItem: + description: Oncall escalation + properties: + email: + description: Oncall email. + type: string + escalationLevel: + description: Oncall level. + format: int64 + type: integer + name: + description: Oncall name. + type: string + type: object + EntityResponseIncludedRelatedOncallEscalations: + description: Oncall escalations + items: + $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem' + type: array + EntityResponseIncludedSchema: + description: Included detail entity schema. + properties: + attributes: + $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes' + id: + description: Entity id. + type: string + type: + description: Schema type. + type: string + type: object + EntityResponseIncludedSchemaAttributes: + description: Included schema. + properties: + schema: + $ref: '#/components/schemas/EntityV3' + type: object + EntityResponseMeta: + description: Entity metadata. + properties: + count: + description: Total entities count. + format: int64 + type: integer + includeCount: + description: Total included data count. + format: int64 + type: integer + type: object + EntityToIncidents: + description: Entity to incidents relationship. + properties: + data: + $ref: '#/components/schemas/RelationshipArray' + type: object + EntityToOncalls: + description: Entity to oncalls relationship. + properties: + data: + $ref: '#/components/schemas/RelationshipArray' + type: object + EntityToRawSchema: + description: Entity to raw schema relationship. + properties: + data: + $ref: '#/components/schemas/RelationshipItem' + type: object + EntityToRelatedEntities: + description: Entity to related entities relationship. + properties: + data: + $ref: '#/components/schemas/RelationshipArray' + type: object + EntityToSchema: + description: Entity to detail schema relationship. + properties: + data: + $ref: '#/components/schemas/RelationshipItem' + type: object + EntityV3: + description: Entity schema v3. + oneOf: + - $ref: '#/components/schemas/EntityV3Service' + - $ref: '#/components/schemas/EntityV3Datastore' + - $ref: '#/components/schemas/EntityV3Queue' + - $ref: '#/components/schemas/EntityV3System' + EntityV3APIVersion: + description: The schema version of entity type. The field is known as schema-version + in the previous version + enum: + - v3 + example: v3 + type: string + x-enum-varnames: + - V3 + EntityV3DatadogCodeLocationItem: + additionalProperties: false + description: code location item. + properties: + paths: + description: The paths (glob) to the source code of the service + items: + type: string + type: array + repositoryURL: + description: The repository path of the source code of the entity + pattern: url + type: string + type: object + EntityV3DatadogCodeLocations: + additionalProperties: false + description: Schema for mapping source code locations to an entity + items: + $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem' + type: array + EntityV3DatadogEventItem: + additionalProperties: false + description: Events association item. + properties: + name: + description: The name of the query + type: string + query: + description: The query to run + type: string + type: object + EntityV3DatadogEvents: + additionalProperties: false + description: Events associations + items: + $ref: '#/components/schemas/EntityV3DatadogEventItem' + type: array + EntityV3DatadogIntegrationOpsgenie: + additionalProperties: false + description: An Opsgenie integration schema + properties: + region: + description: The region for the Opsgenie integration. + minLength: 1 + type: string + serviceURL: + description: The service url for the Opsgenie integration. + example: https://www.opsgenie.com/service/shopping-cart + minLength: 1 + type: string + required: + - serviceURL + type: object + EntityV3DatadogIntegrationPagerduty: + additionalProperties: false + description: An PagerDuty integration schema + properties: + serviceURL: + description: The service url for the PagerDuty integration. + example: https://www.pagerduty.com/service-directory/Pshopping-cart + minLength: 1 + type: string + required: + - serviceURL + type: object + EntityV3DatadogLogItem: + additionalProperties: false + description: log association item. + properties: + name: + description: The name of the query + type: string + query: + description: The query to run + type: string + type: object + EntityV3DatadogLogs: + additionalProperties: false + description: Logs association + items: + $ref: '#/components/schemas/EntityV3DatadogLogItem' + type: array + EntityV3DatadogPerformance: + additionalProperties: false + description: Performance stats association + properties: + tags: + description: A list of APM entity tags that associates the APM Stats data + with the entity + items: + type: string + type: array + type: object + EntityV3DatadogPipelines: + additionalProperties: false + description: CI Pipelines association + properties: + fingerprints: + description: A list of CI Fingerprints that associate CI Pipelines with + the entity + items: + type: string + type: array + type: object + EntityV3Datastore: + additionalProperties: false + description: Schema for datastore entities + properties: + apiVersion: + $ref: '#/components/schemas/EntityV3APIVersion' + datadog: + $ref: '#/components/schemas/EntityV3DatastoreDatadog' + extensions: + additionalProperties: {} + description: Custom extensions. This is the free-formed field to send client + side metadata. No Datadog features are affected by this field. + type: object + integrations: + $ref: '#/components/schemas/EntityV3Integrations' + kind: + $ref: '#/components/schemas/EntityV3DatastoreKind' + metadata: + $ref: '#/components/schemas/EntityV3Metadata' + spec: + $ref: '#/components/schemas/EntityV3DatastoreSpec' + required: + - apiVersion + - kind + - metadata + type: object + EntityV3DatastoreDatadog: + additionalProperties: false + description: Datadog product integrations for the datastore entity + properties: + events: + $ref: '#/components/schemas/EntityV3DatadogEvents' + logs: + $ref: '#/components/schemas/EntityV3DatadogLogs' + performanceData: + $ref: '#/components/schemas/EntityV3DatadogPerformance' + type: object + EntityV3DatastoreKind: + description: The definition of Entity V3 Datastore Kind object. + enum: + - datastore + example: datastore + type: string + x-enum-varnames: + - DATASTORE + EntityV3DatastoreSpec: + additionalProperties: false + description: The definition of Entity V3 Datastore Spec object. + properties: + lifecycle: + description: The lifecycle state of the datastore. + minLength: 1 + type: string + tier: + description: The importance of the datastore + minLength: 1 + type: string + type: + description: The type of datastore + type: string + type: object + EntityV3Integrations: + additionalProperties: false + description: A base schema for defining third party integrations + properties: + opsgenie: + $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie' + pagerduty: + $ref: '#/components/schemas/EntityV3DatadogIntegrationPagerduty' + type: object + EntityV3Metadata: + additionalProperties: false + description: The definition of Entity V3 Metadata object. + properties: + additionalOwners: + additionalProperties: false + description: The additional owners of the entity, usually a team + items: + $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems' + type: array + contacts: + additionalProperties: false + description: A list of contacts for the entity + items: + $ref: '#/components/schemas/EntityV3MetadataContactsItems' + type: array + description: + description: Short description of the entity. The UI can leverage the description + for display + type: string + displayName: + description: User friendly name of the entity. The UI can leverage the display + name for display + type: string + id: + description: A read-only globally unique identifier for the entity generated + by Datadog. User supplied values are ignored. + example: 4b163705-23c0-4573-b2fb-f6cea2163fcb + minLength: 1 + type: string + inheritFrom: + description: The entity reference from which to inherit metadata + example: application:default/myapp + type: string + links: + additionalProperties: false + description: A list of links for the entity + items: + $ref: '#/components/schemas/EntityV3MetadataLinksItems' + type: array + managed: + additionalProperties: {} + description: A read-only set of Datadog managed attributes generated by + Datadog. User supplied values are ignored. + type: object + name: + description: 'Unique name given to an entity under the kind/namespace ' + example: myService + minLength: 1 + type: string + namespace: + description: Namespace is a part of unique identifier. It has a default + value of 'default' + example: default + minLength: 1 + type: string + owner: + $ref: '#/components/schemas/EntityV3MetadataOwner' + tags: + description: A set of custom tags + example: + - this:tag + - that:tag + items: + type: string + type: array + required: + - name + type: object + EntityV3MetadataAdditionalOwnersItems: + description: The definition of Entity V3 Metadata Additional Owners Items object. + properties: + name: + description: Team name + example: '' + type: string + type: + description: Team type + type: string + required: + - name + EntityV3MetadataContactsItems: + additionalProperties: false + description: The definition of Entity V3 Metadata Contacts Items object. + properties: + contact: + description: Contact value + example: https://slack/ + type: string + name: + description: Contact name + minLength: 2 + type: string + type: + description: Contact type. + example: slack + type: string + required: + - type + - contact + type: object + EntityV3MetadataLinksItems: + additionalProperties: false + description: The definition of Entity V3 Metadata Links Items object. + properties: + name: + description: Link name + example: mylink + type: string + provider: + description: Link provider. + type: string + type: + default: other + description: Link type. + example: link + type: string + url: + description: Link url + example: https://mylink + type: string + required: + - name + - type + - url + type: object + EntityV3MetadataOwner: + additionalProperties: false + description: The owner of the entity, usually a team + properties: + name: + description: Team name + type: string + EntityV3Queue: + additionalProperties: false + description: Schema for queue entities + properties: + apiVersion: + $ref: '#/components/schemas/EntityV3APIVersion' + datadog: + $ref: '#/components/schemas/EntityV3QueueDatadog' + extensions: + additionalProperties: {} + description: Custom extensions. This is the free-formed field to send client + side metadata. No Datadog features are affected by this field. + type: object + integrations: + $ref: '#/components/schemas/EntityV3Integrations' + kind: + $ref: '#/components/schemas/EntityV3QueueKind' + metadata: + $ref: '#/components/schemas/EntityV3Metadata' + spec: + $ref: '#/components/schemas/EntityV3QueueSpec' + required: + - apiVersion + - kind + - metadata + type: object + EntityV3QueueDatadog: + additionalProperties: false + description: Datadog product integrations for the datastore entity + properties: + events: + $ref: '#/components/schemas/EntityV3DatadogEvents' + logs: + $ref: '#/components/schemas/EntityV3DatadogLogs' + performanceData: + $ref: '#/components/schemas/EntityV3DatadogPerformance' + type: object + EntityV3QueueKind: + description: The definition of Entity V3 Queue Kind object. + enum: + - queue + example: queue + type: string + x-enum-varnames: + - QUEUE + EntityV3QueueSpec: + additionalProperties: false + description: The definition of Entity V3 Queue Spec object. + properties: + lifecycle: + description: The lifecycle state of the queue. + minLength: 1 + type: string + tier: + description: The importance of the queue + minLength: 1 + type: string + type: + description: The type of queue + type: string + type: object + EntityV3Service: + additionalProperties: false + description: Schema for service entities + properties: + apiVersion: + $ref: '#/components/schemas/EntityV3APIVersion' + datadog: + $ref: '#/components/schemas/EntityV3ServiceDatadog' + extensions: + additionalProperties: {} + description: Custom extensions. This is the free-formed field to send client + side metadata. No Datadog features are affected by this field. + type: object + integrations: + $ref: '#/components/schemas/EntityV3Integrations' + kind: + $ref: '#/components/schemas/EntityV3ServiceKind' + metadata: + $ref: '#/components/schemas/EntityV3Metadata' + spec: + $ref: '#/components/schemas/EntityV3ServiceSpec' + required: + - apiVersion + - kind + - metadata + type: object + EntityV3ServiceDatadog: + additionalProperties: false + description: Datadog product integrations for the service entity + properties: + codeLocations: + $ref: '#/components/schemas/EntityV3DatadogCodeLocations' + events: + $ref: '#/components/schemas/EntityV3DatadogEvents' + logs: + $ref: '#/components/schemas/EntityV3DatadogLogs' + performanceData: + $ref: '#/components/schemas/EntityV3DatadogPerformance' + pipelines: + $ref: '#/components/schemas/EntityV3DatadogPipelines' + type: object + EntityV3ServiceKind: + description: The definition of Entity V3 Service Kind object. + enum: + - service + example: service + type: string + x-enum-varnames: + - SERVICE + EntityV3ServiceSpec: + additionalProperties: false + description: The definition of Entity V3 Service Spec object. + properties: + dependsOn: + description: A list of components the service depends on + items: + type: string + type: array + languages: + description: The service's programming language. + items: + type: string + type: array + lifecycle: + description: The lifecycle state of the component. + minLength: 1 + type: string + tier: + description: The importance of the component + minLength: 1 + type: string + type: + description: The type of service + type: string + type: object + EntityV3System: + additionalProperties: false + description: Schema for system entities + properties: + apiVersion: + $ref: '#/components/schemas/EntityV3APIVersion' + datadog: + $ref: '#/components/schemas/EntityV3SystemDatadog' + extensions: + additionalProperties: {} + description: Custom extensions. This is the free-formed field to send client + side metadata. No Datadog features are affected by this field. + type: object + integrations: + $ref: '#/components/schemas/EntityV3Integrations' + kind: + $ref: '#/components/schemas/EntityV3SystemKind' + metadata: + $ref: '#/components/schemas/EntityV3Metadata' + spec: + $ref: '#/components/schemas/EntityV3SystemSpec' + required: + - apiVersion + - kind + - metadata + type: object + EntityV3SystemDatadog: + additionalProperties: false + description: Datadog product integrations for the service entity + properties: + events: + $ref: '#/components/schemas/EntityV3DatadogEvents' + logs: + $ref: '#/components/schemas/EntityV3DatadogLogs' + performanceData: + $ref: '#/components/schemas/EntityV3DatadogPerformance' + pipelines: + $ref: '#/components/schemas/EntityV3DatadogPipelines' + type: object + EntityV3SystemKind: + description: The definition of Entity V3 System Kind object. + enum: + - system + example: system + type: string + x-enum-varnames: + - SYSTEM + EntityV3SystemSpec: + additionalProperties: false + description: The definition of Entity V3 System Spec object. + properties: + components: + description: A list of components belongs to the system. + items: + type: string + type: array + lifecycle: + description: The lifecycle state of the component. + minLength: 1 + type: string + tier: + description: An entity reference to the owner of the component. + minLength: 1 + type: string + type: object Event: description: The metadata associated with a request. properties: id: description: Event ID. @@ -8153,10 +9045,13 @@ properties: api_key: description: The API key of the Fastly account. example: ABCDEFG123 type: string + name: + description: The name of the Fastly account. + type: string type: object FastlyAccountUpdateRequestData: description: Data object for updating a Fastly account. properties: attributes: @@ -8449,10 +9344,11 @@ description: The category of the API key. type: string created_at: description: Creation date of the API key. example: '2020-11-23T10:00:00.000Z' + format: date-time readOnly: true type: string key: description: The API key. readOnly: true @@ -8465,10 +9361,11 @@ readOnly: true type: string modified_at: description: Date the API key was last modified. example: '2020-11-23T10:00:00.000Z' + format: date-time readOnly: true type: string name: description: Name of the API key. example: API Key for submitting metrics @@ -9382,10 +10279,23 @@ data: description: 'An array of incident attachments. Only the attachments that were created or updated by the request are returned.' + example: + - attributes: + attachment: + documentUrl: '' + title: Postmortem IR-123 + attachment_type: postmortem + id: 00000000-abcd-0002-0000-000000000000 + relationships: + last_modified_by_user: + data: + id: 00000000-0000-0000-cccc-000000000000 + type: users + type: incident_attachments items: $ref: '#/components/schemas/IncidentAttachmentData' type: array included: description: Included related resources that the user requested. @@ -9413,10 +10323,23 @@ IncidentAttachmentsResponse: description: The response object containing an incident's attachments. properties: data: description: An array of incident attachments. + example: + - attributes: + attachment: + documentUrl: '' + title: Postmortem IR-123 + attachment_type: postmortem + id: 00000000-abcd-0002-0000-000000000000 + relationships: + last_modified_by_user: + data: + id: 00000000-0000-0000-cccc-000000000000 + type: users + type: incident_attachments items: $ref: '#/components/schemas/IncidentAttachmentData' type: array included: description: Included related resources that the user requested. @@ -9506,12 +10429,10 @@ description: Dynamic fields for which selections can be made, with field names as keys. oneOf: - $ref: '#/components/schemas/IncidentFieldAttributesSingleValue' - $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue' - required: - - type IncidentFieldAttributesMultipleValue: description: A field with potentially multiple values selected. properties: type: $ref: '#/components/schemas/IncidentFieldAttributesValueType' @@ -10624,10 +11545,12 @@ oneOf: - $ref: '#/components/schemas/IncidentTodoAssigneeHandle' - $ref: '#/components/schemas/IncidentTodoAnonymousAssignee' IncidentTodoAssigneeArray: description: Array of todo assignees. + example: + - '@test.user@test.com' items: $ref: '#/components/schemas/IncidentTodoAssignee' type: array IncidentTodoAssigneeHandle: description: Assignee's @-handle. @@ -10984,10 +11907,25 @@ meta: $ref: '#/components/schemas/IncidentResponseMeta' required: - data type: object + IncludeType: + description: supported include types. + enum: + - schema + - raw_schema + - oncall + - incident + - relation + type: string + x-enum-varnames: + - SCHEMA + - RAW_SCHEMA + - ONCALL + - INCIDENT + - RELATION IntakePayloadAccepted: description: The payload accepted for intake. properties: errors: description: A list of errors. @@ -11128,10 +12066,49 @@ type: string project_key: description: Jira project key type: string type: object + LeakedKey: + description: The definition of LeakedKey object. + properties: + attributes: + $ref: '#/components/schemas/LeakedKeyAttributes' + id: + description: The LeakedKey id. + example: id + type: string + type: + $ref: '#/components/schemas/LeakedKeyType' + required: + - attributes + - id + - type + type: object + LeakedKeyAttributes: + description: The definition of LeakedKeyAttributes object. + properties: + date: + description: The LeakedKeyAttributes date. + example: '2017-07-21T17:32:28Z' + format: date-time + type: string + leak_source: + description: The LeakedKeyAttributes leak_source. + type: string + required: + - date + type: object + LeakedKeyType: + default: leaked_keys + description: The definition of LeakedKeyType object. + enum: + - leaked_keys + example: leaked_keys + type: string + x-enum-varnames: + - LEAKED_KEYS ListAPIsResponse: description: Response for `ListAPIs`. properties: data: description: List of API items. @@ -11238,10 +12215,48 @@ $ref: '#/components/schemas/DowntimeResponseIncludedItem' type: array meta: $ref: '#/components/schemas/DowntimeMeta' type: object + ListEntityCatalogResponse: + description: List entity response. + properties: + data: + $ref: '#/components/schemas/EntityResponseData' + included: + $ref: '#/components/schemas/ListEntityCatalogResponseIncluded' + links: + $ref: '#/components/schemas/ListEntityCatalogResponseLinks' + meta: + $ref: '#/components/schemas/EntityResponseMeta' + type: object + ListEntityCatalogResponseIncluded: + description: List entity response included. + items: + $ref: '#/components/schemas/ListEntityCatalogResponseIncludedItem' + type: array + ListEntityCatalogResponseIncludedItem: + description: List entity response included item. + oneOf: + - $ref: '#/components/schemas/EntityResponseIncludedSchema' + - $ref: '#/components/schemas/EntityResponseIncludedRawSchema' + - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntity' + - $ref: '#/components/schemas/EntityResponseIncludedOncall' + - $ref: '#/components/schemas/EntityResponseIncludedIncident' + ListEntityCatalogResponseLinks: + description: List entity response links. + properties: + next: + description: next link. + type: string + previous: + description: previous link. + type: string + self: + description: current link. + type: string + type: object ListFindingsData: description: Array of findings. items: $ref: '#/components/schemas/Finding' type: array @@ -11741,13 +12756,10 @@ description: An archive's destination. oneOf: - $ref: '#/components/schemas/LogsArchiveDestinationAzure' - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - $ref: '#/components/schemas/LogsArchiveDestinationS3' - required: - - type - - integration LogsArchiveDefinition: description: The definition of an archive. properties: attributes: $ref: '#/components/schemas/LogsArchiveAttributes' @@ -11770,13 +12782,11 @@ nullable: true oneOf: - $ref: '#/components/schemas/LogsArchiveDestinationAzure' - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - $ref: '#/components/schemas/LogsArchiveDestinationS3' - required: - - type - - integration + type: object LogsArchiveDestinationAzure: description: The Azure archive destination. properties: container: description: The container where the archive will be stored. @@ -12567,15 +13577,18 @@ data: $ref: '#/components/schemas/MetricAllTags' readOnly: true type: object MetricAssetAttributes: - description: Assets where only included attribute is its title + description: Assets related to the object, including title and url. properties: title: description: Title of the asset. type: string + url: + description: URL path of the asset. + type: string type: object MetricAssetDashboardRelationship: description: An object of type `dashboard` that can be referenced in the `included` data. properties: @@ -12779,11 +13792,10 @@ example: - sue@example.com - bob@example.com items: description: An email address. - format: email type: string type: array MetricBulkTagConfigNamePrefix: description: A text prefix to match against metric names. example: kafka.lag @@ -12951,21 +13963,25 @@ required: - id - type type: object MetricDashboardAttributes: - description: Attributes related to the dashboard, including title and popularity. + description: Attributes related to the dashboard, including title, popularity, + and url. properties: popularity: description: Value from 0 to 5 that ranks popularity of the dashboard. format: double maximum: 5 minimum: 0 type: number title: description: Title of the asset. type: string + url: + description: URL path of the asset. + type: string type: object MetricDashboardID: description: The related dashboard's ID. example: xxx-yyy-zzz type: string @@ -13289,10 +14305,13 @@ points: description: Points relating to a metric. All points must be objects with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. + example: + - timestamp: 1575317847 + value: 0.5 items: $ref: '#/components/schemas/MetricPoint' type: array resources: description: A list of resources to associate with this metric. @@ -14295,10 +15314,11 @@ example: https://example.com type: string name: description: The name for the Opsgenie service. example: fake-opsgenie-service-name + maxLength: 100 type: string opsgenie_api_key: description: The Opsgenie API key for your Opsgenie service. example: 00000000-0000-0000-0000-000000000000 type: string @@ -14357,10 +15377,11 @@ nullable: true type: string name: description: The name for the Opsgenie service. example: fake-opsgenie-service-name + maxLength: 100 type: string region: $ref: '#/components/schemas/OpsgenieServiceRegionType' type: object OpsgenieServiceResponseData: @@ -14369,10 +15390,12 @@ attributes: $ref: '#/components/schemas/OpsgenieServiceResponseAttributes' id: description: The ID of the Opsgenie service. example: 596da4af-0563-4097-90ff-07230c3f9db3 + maxLength: 100 + minLength: 1 type: string type: $ref: '#/components/schemas/OpsgenieServiceType' required: - id @@ -14397,10 +15420,11 @@ nullable: true type: string name: description: The name for the Opsgenie service. example: fake-opsgenie-service-name + maxLength: 100 type: string opsgenie_api_key: description: The Opsgenie API key for your Opsgenie service. example: 00000000-0000-0000-0000-000000000000 type: string @@ -14413,10 +15437,12 @@ attributes: $ref: '#/components/schemas/OpsgenieServiceUpdateAttributes' id: description: The ID of the Opsgenie service. example: 596da4af-0563-4097-90ff-07230c3f9db3 + maxLength: 100 + minLength: 1 type: string type: $ref: '#/components/schemas/OpsgenieServiceType' required: - id @@ -16303,10 +17329,50 @@ description: A short human-readable summary of the warning. example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object + RelationType: + description: supported relation types + enum: + - RelationTypeOwns + - RelationTypeOwnedBy + - RelationTypeDependsOn + - RelationTypeDependencyOf + - RelationTypePartsOf + - RelationTypeHasPart + - RelationTypeOtherOwns + - RelationTypeOtherOwnedBy + - RelationTypeImplementedBy + - RelationTypeImplements + type: string + x-enum-varnames: + - RELATIONTYPEOWNS + - RELATIONTYPEOWNEDBY + - RELATIONTYPEDEPENDSON + - RELATIONTYPEDEPENDENCYOF + - RELATIONTYPEPARTSOF + - RELATIONTYPEHASPART + - RELATIONTYPEOTHEROWNS + - RELATIONTYPEOTHEROWNEDBY + - RELATIONTYPEIMPLEMENTEDBY + - RELATIONTYPEIMPLEMENTS + RelationshipArray: + description: Relationships. + items: + $ref: '#/components/schemas/RelationshipItem' + type: array + RelationshipItem: + description: Relationship entry. + properties: + id: + description: Associated data id. + type: string + type: + description: Relationship type. + type: string + type: object RelationshipToIncidentAttachment: description: A relationship reference for attachments. properties: data: description: An array of incident attachments. @@ -17630,10 +18696,14 @@ - from - queries type: object ScalarFormulaRequestQueries: description: List of queries to be run and used as inputs to the formulas. + example: + - aggregator: avg + data_source: metrics + query: avg:system.cpu.user{*} by {env} items: $ref: '#/components/schemas/ScalarQuery' type: array ScalarFormulaRequestType: default: scalar_request @@ -18588,10 +19658,12 @@ format: date-time type: string type: object SecurityMonitoringSignalIncidentIds: description: Array of incidents that are associated with this signal. + example: + - 2066 items: description: Public ID attribute of the incident that is associated with the signal. example: 2066 format: int64 @@ -19495,10 +20567,14 @@ type: string description: description: A description for the suppression rule. example: This rule suppresses low-severity signals in staging environments. type: string + editable: + description: Whether the suppression rule is editable. + example: true + type: boolean enabled: description: Whether the suppression rule is enabled. example: true type: boolean expiration_date: @@ -20590,11 +21666,10 @@ oneOf: - $ref: '#/components/schemas/ServiceDefinitionV1' - $ref: '#/components/schemas/ServiceDefinitionV2' - $ref: '#/components/schemas/ServiceDefinitionV2Dot1' - $ref: '#/components/schemas/ServiceDefinitionV2Dot2' - type: object ServiceDefinitionSchemaVersions: description: Schema versions enum: - v1 - v2 @@ -20648,11 +21723,10 @@ description: Contact information about the service. properties: email: description: "Service owner\u2019s email." example: contact@datadoghq.com - format: email type: string slack: description: "Service owner\u2019s Slack channel." example: https://yourcompany.slack.com/archives/channel123 type: string @@ -20909,11 +21983,10 @@ description: Service owner's email. properties: contact: description: Contact value. example: contact@datadoghq.com - format: email type: string name: description: Contact email. example: Team Email type: string @@ -21270,11 +22343,10 @@ description: Service owner's email. properties: contact: description: Contact value. example: contact@datadoghq.com - format: email type: string name: description: Contact email. example: Team Email type: string @@ -22654,11 +23726,10 @@ readOnly: true type: string url: description: The URL for the link example: https://example.com - format: url type: string required: - label - url type: object @@ -23107,10 +24178,13 @@ - from - queries type: object TimeseriesFormulaRequestQueries: description: List of queries to be run and used as inputs to the formulas. + example: + - data_source: metrics + query: avg:system.cpu.user{*} by {env} items: $ref: '#/components/schemas/TimeseriesQuery' type: array TimeseriesFormulaRequestType: default: timeseries_request @@ -23297,10 +24371,34 @@ relationships: $ref: '#/components/schemas/RelationshipToRule' type: $ref: '#/components/schemas/RuleType' type: object + UpsertCatalogEntityRequest: + description: Create / Update entity request. + oneOf: + - $ref: '#/components/schemas/EntityV3' + - $ref: '#/components/schemas/EntityRaw' + UpsertCatalogEntityResponse: + description: Upsert entity response. + properties: + data: + $ref: '#/components/schemas/EntityResponseData' + included: + $ref: '#/components/schemas/UpsertCatalogEntityResponseIncluded' + meta: + $ref: '#/components/schemas/EntityResponseMeta' + type: object + UpsertCatalogEntityResponseIncluded: + description: Upsert entity response included. + items: + $ref: '#/components/schemas/UpsertCatalogEntityResponseIncludedItem' + type: array + UpsertCatalogEntityResponseIncludedItem: + description: Upsert entity response included item. + oneOf: + - $ref: '#/components/schemas/EntityResponseIncludedSchema' UsageApplicationSecurityMonitoringResponse: description: Application Security Monitoring usage response. properties: data: description: Response containing Application Security Monitoring usage. @@ -24039,10 +25137,11 @@ ci_visibility_read: View CI Visibility. cloud_cost_management_read: View Cloud Cost pages. This does not restrict access to the cloud cost data source in dashboards and notebooks. cloud_cost_management_write: Configure cloud cost accounts and global customizations. + 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_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. @@ -25787,10 +26886,113 @@ - AuthZ: - cases_write summary: Unassign case tags: - Case Management + /api/v2/catalog/entity: + get: + description: Get a list of entities from Software Catalog. + operationId: ListCatalogEntity + parameters: + - $ref: '#/components/parameters/PageOffset' + - description: Maximum number of entities in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + type: integer + - $ref: '#/components/parameters/FilterByID' + - $ref: '#/components/parameters/FilterByRef' + - $ref: '#/components/parameters/FilterByName' + - $ref: '#/components/parameters/FilterByKind' + - $ref: '#/components/parameters/FilterByOwner' + - $ref: '#/components/parameters/FilterByRelationType' + - $ref: '#/components/parameters/FilterByExcludeSnapshot' + - $ref: '#/components/parameters/Include' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListEntityCatalogResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read + summary: Get a list of entities + tags: + - Software Catalog + x-pagination: + limitParam: page[limit] + pageParam: page[offset] + resultsPath: data + post: + description: Create or update entities in Software Catalog. + operationId: UpsertCatalogEntity + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertCatalogEntityRequest' + description: Entity YAML/JSON. + required: true + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertCatalogEntityResponse' + description: ACCEPTED + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write + summary: Create or update entities + tags: + - Software Catalog + x-codegen-request-body-name: body + /api/v2/catalog/entity/{entity_id}: + delete: + description: Delete a single entity in Software Catalog. + operationId: DeleteCatalogEntity + parameters: + - $ref: '#/components/parameters/EntityID' + responses: + '204': + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write + summary: Delete a single entity + tags: + - Software Catalog /api/v2/ci/pipeline: post: description: 'Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). @@ -27674,17 +28876,17 @@ in: query name: filter[query] required: false schema: type: string - - description: Minimum timestamp for requested events. + - description: Minimum timestamp for requested events, in milliseconds. in: query name: filter[from] required: false schema: type: string - - description: Maximum timestamp for requested events. + - description: Maximum timestamp for requested events, in milliseconds. in: query name: filter[to] required: false schema: type: string @@ -32607,15 +33809,15 @@ - Security Rules: `security-rule` - Service Level Objectives: `slo` - - Synthetic Global Variables: `synthetic-global-variable` + - Synthetic Global Variables: `synthetics-global-variable` - - Synthetic Tests: `synthetic-test` + - Synthetic Tests: `synthetics-test` - - Synthetic Private Locations: `synthetic-private-location` + - Synthetic Private Locations: `synthetics-private-location` - Monitors: `monitor` #### Supported relations for resources @@ -38338,12 +39540,14 @@ - description: View and manage cases and projects within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information. name: Case Management - description: The Cloud Cost Management API allows you to set up, edit, and delete - Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management - page](https://docs.datadoghq.com/cloud_cost_management/) for more information. + Cloud Cost Management accounts for AWS and Azure. You can query your cost data + by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products) + and the `cloud_cost` data source. For more information, see the [Cloud Cost Management + documentation](https://docs.datadoghq.com/cloud_cost_management/). name: Cloud Cost Management - description: Manage your Datadog Cloudflare integration directly through the Datadog API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/) for more information. name: Cloudflare Integration @@ -38593,9 +39797,13 @@ This feature is currently in BETA. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' name: Service Scorecards +- description: API to create, update, retrieve and delete Software Catalog entities. + externalDocs: + url: https://docs.datadoghq.com/service_catalog/service_definitions#metadata-schema-v30-beta + name: Software Catalog - description: Search and aggregate your spans from your Datadog platform over HTTP. name: Spans - description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics) for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/) for more information.