Processes

GET https://api.datadoghq.eu/api/v2/processeshttps://api.ddog-gov.com/api/v2/processeshttps://api.datadoghq.com/api/v2/processeshttps://api.us3.datadoghq.com/api/v2/processes

Overview

Get all processes for your organization.

Arguments

Query Strings

Name

Type

Description

search

string

String to search processes by.

tags

string

Comma-separated list of tags to filter processes by.

from

integer

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].

to

integer

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].

page[limit]

integer

Maximum number of results returned.

page[cursor]

string

String to query the next page of results. This key is provided with each valid response from the API in meta.page.after.

Response

OK

List of process summaries.

Expand All

Field

Type

Description

data

[object]

Array of process summary objects.

attributes

object

Attributes for a process summary.

cmdline

string

Process command line.

host

string

Host running the process.

pid

int64

Process ID.

ppid

int64

Parent process ID.

start

string

Time the process was started.

tags

[string]

List of tags associated with the process.

timestamp

string

Time the process was seen.

user

string

Process owner.

id

string

Process ID.

type

enum

Type of process summary. Allowed enum values: process

meta

object

Response metadata object.

page

object

Paging attributes.

after

string

The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

size

int32

Number of results returned.

{
  "data": [
    {
      "attributes": {
        "cmdline": "string",
        "host": "string",
        "pid": "integer",
        "ppid": "integer",
        "start": "string",
        "tags": [],
        "timestamp": "string",
        "user": "string"
      },
      "id": "string",
      "type": "process"
    }
  ],
  "meta": {
    "page": {
      "after": "911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd",
      "size": "integer"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Authentication Error

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example


# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v2/processes" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
package main

import (
    "context"
    "encoding/json"
    "fmt"
    "os"
    datadog "github.com/DataDog/datadog-api-client-go/api/v2/datadog"
)

func main() {
    ctx := datadog.NewDefaultContext(context.Background())

    search := "search_example" // string | String to search processes by. (optional)
    tags := "account:prod,user:admin" // string | Comma-separated list of tags to filter processes by. (optional)
    from := int64(789) // int64 | 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)
    to := int64(789) // int64 | 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)
    pageLimit := int32(56) // int32 | Maximum number of results returned. (optional) (default to 1000)
    pageCursor := "pageCursor_example" // 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)
    optionalParams := datadog.ListProcessesOptionalParameters{
        Search: &search,
        Tags: &tags,
        From: &from,
        To: &to,
        PageLimit: &pageLimit,
        PageCursor: &pageCursor,
    }

    configuration := datadog.NewConfiguration()

    apiClient := datadog.NewAPIClient(configuration)
    resp, r, err := apiClient.ProcessesApi.ListProcesses(ctx, optionalParams)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProcessesApi.ListProcesses`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListProcesses`: ProcessSummariesResponse
    responseContent, _ := json.MarshalIndent(resp, "", "  ")
    fmt.Fprintf(os.Stdout, "Response from ProcessesApi.ListProcesses:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

              
export DD_SITE="datadoghq.comus3.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
import os
from dateutil.parser import parse as dateutil_parser
from datadog_api_client.v2 import ApiClient, ApiException, Configuration
from datadog_api_client.v2.api import processes_api
from datadog_api_client.v2.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration()

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = processes_api.ProcessesApi(api_client)
    search = "search_example"  # str | String to search processes by. (optional)
    tags = "account:prod,user:admin"  # str | Comma-separated list of tags to filter processes by. (optional)
    _from = 1  # int | 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)
    to = 1  # int | 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)
    page_limit = 1000  # int | Maximum number of results returned. (optional) if omitted the server will use the default value of 1000
    page_cursor = "page[cursor]_example"  # str | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all processes
        api_response = api_instance.list_processes(search=search, tags=tags, _from=_from, to=to, page_limit=page_limit, page_cursor=page_cursor)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProcessesApi->list_processes: %s\n" % e)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

              
export DD_SITE="datadoghq.comus3.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
require 'datadog_api_client'
api_instance = DatadogAPIClient::V2::ProcessesAPI.new
opts = {
  search: 'search_example', # String | String to search processes by.
  tags: 'account:prod,user:admin', # String | Comma-separated list of tags to filter processes by.
  from: 789, # Integer | 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]`.
  to: 789, # Integer | 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]`.
  page_limit: 56, # Integer | Maximum number of results returned.
  page_cursor: 'page_cursor_example' # String | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`.
}

begin
  # Get all processes
  result = api_instance.list_processes(opts)
  p result
rescue DatadogAPIClient::V2::APIError => e
  puts "Error when calling ProcessesAPI->list_processes: #{e}"
end

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

              
export DD_SITE="datadoghq.comus3.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
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));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

              
export DD_SITE="datadoghq.comus3.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
import java.util.*;
import com.datadog.api.v2.client.ApiClient;
import com.datadog.api.v2.client.ApiException;
import com.datadog.api.v2.client.Configuration;
import com.datadog.api.v2.client.model.*;
import com.datadog.api.v2.client.api.ProcessesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        ProcessesApi apiInstance = new ProcessesApi(defaultClient);
        String search = "search_example"; // String | String to search processes by.
        String tags = "account:prod,user:admin"; // String | Comma-separated list of tags to filter processes by.
        Long from = 56L; // Long | 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]`.
        Long to = 56L; // Long | 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]`.
        Integer pageLimit = 1000; // Integer | Maximum number of results returned.
        String pageCursor = "pageCursor_example"; // String | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`.
        try {
	    ProcessSummariesResponse result = apiInstance.listProcesses(new ProcessesApi.ListProcessesOptionalParameters()
                .search(search)
                .tags(tags)
                .from(from)
                .to(to)
                .pageLimit(pageLimit)
                .pageCursor(pageCursor));
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessesApi#listProcesses");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

              
export DD_SITE="datadoghq.comus3.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"