{ "opencollection": "1.0.0", "info": { "name": "Datadog Account Pipelines API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Pipelines", "type": "folder" }, "items": [ { "info": { "name": "Datadog Send Pipeline Event", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipeline", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "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/).\n\nPipeline events can be submitted with a timestamp that is up to 18 hours in the past." }, { "info": { "name": "Datadog Aggregate Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/analytics/aggregate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries." }, { "info": { "name": "Datadog Get a List of Pipelines Events", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events", "params": [ { "name": "filter[query]", "value": "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler", "type": "query", "description": "Search query following log syntax." }, { "name": "filter[from]", "value": "2019-01-02T09:42:36.320Z", "type": "query", "description": "Minimum timestamp for requested events." }, { "name": "filter[to]", "value": "2019-01-03T09:42:36.320Z", "type": "query", "description": "Maximum timestamp for requested events." }, { "name": "sort", "value": "example_value", "type": "query", "description": "Order of events in results." }, { "name": "page[cursor]", "value": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "query", "description": "List following results with a cursor provided in the previous query." }, { "name": "page[limit]", "value": "25", "type": "query", "description": "Maximum number of events in the response." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest pipeline events." }, { "info": { "name": "Datadog Search Pipelines Events", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/ci/pipelines/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to build complex events filtering and search." }, { "info": { "name": "Datadog List Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Size for a given page. The maximum allowed value is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specific page number to return." } ] }, "docs": "Retrieve a list of pipelines." }, { "info": { "name": "Datadog Create a New Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pipeline." }, { "info": { "name": "Datadog Validate an Observability Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validates a pipeline configuration without creating or updating any resources.\nReturns a list of validation errors, if any.\n" }, { "info": { "name": "Datadog Get a Specific Pipeline", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "abc-123-def", "type": "path", "description": "The ID of the pipeline to retrieve." } ] }, "docs": "Get a specific pipeline by its ID." }, { "info": { "name": "Datadog Update a Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "abc-123-def", "type": "path", "description": "The ID of the pipeline to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a pipeline." }, { "info": { "name": "Datadog Delete a Pipeline", "type": "http" }, "http": { "method": "DELETE", "url": "https://{subdomain}.{site}/api/v2/remote_config/products/obs_pipelines/pipelines/:pipeline_id", "params": [ { "name": "pipeline_id", "value": "abc-123-def", "type": "path", "description": "The ID of the pipeline to delete." } ] }, "docs": "Delete a pipeline." }, { "info": { "name": "Datadog Get Hourly Usage for Observability Pipelines", "type": "http" }, "http": { "method": "GET", "url": "https://{subdomain}.{site}/api/v2/usage/observability_pipelines", "params": [ { "name": "start_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." }, { "name": "end_hr", "value": "example_value", "type": "query", "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour." } ], "auth": { "type": "apikey", "key": "DD-API-KEY", "value": "{{DD-API-KEY}}", "placement": "header" } }, "docs": "Get hourly usage for observability pipelines.\n**Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)" } ] } ], "bundled": true }