Skip to content

ProcessesApi.md

Latest commit

 

History

History
81 lines (60 loc) · 5.63 KB

ProcessesApi.md

File metadata and controls

81 lines (60 loc) · 5.63 KB

datadog-api-client.v2.ProcessesApi

All URIs are relative to https://api.datadoghq.com

Method HTTP request Description
listProcesses GET /api/v2/processes Get all processes

listProcesses

ProcessSummariesResponse listProcesses()

Get all processes for your organization.

Example

import { v2 } from "@datadog/datadog-api-client";
import * as fs from "fs";

const configuration = v2.createConfiguration();
const apiInstance = new v2.ProcessesApi(configuration);

let params: v2.ProcessesApiListProcessesRequest = {
  // string | String to search processes by. (optional)
  search: "search_example",
  // string | Comma-separated list of tags to filter processes by. (optional)
  tags: "account:prod,user:admin",
  // number | Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. (optional)
  from: 1,
  // number | Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. (optional)
  to: 1,
  // number | Maximum number of results returned. (optional)
  pageLimit: 1000,
  // string | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional)
  pageCursor: "page[cursor]_example",
};

apiInstance
  .listProcesses(params)
  .then((data: any) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Parameters

Name Type Description Notes
search [string] String to search processes by. (optional) defaults to undefined
tags [string] Comma-separated list of tags to filter processes by. (optional) defaults to undefined
from [number] Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. (optional) defaults to undefined
to [number] Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. (optional) defaults to undefined
pageLimit [number] Maximum number of results returned. (optional) defaults to 1000
pageCursor [string] String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional) defaults to undefined

Return type

ProcessSummariesResponse

Authorization

AuthZ, apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]