List Processes

• Processes

List processes

Retrieve all processes.

Request

URI

GET

https://api.example.local/v3/processes

COPY

Query Parameters

integer

page

Optional

Page to display; valid values are integers >= 1

page example

1

integer

per_page

Optional

Number of results per page, valid values are 1 through 5000

per_page example

50

string

order_by

Optional

Value to sort by. Defaults to ascending; prepend with - to sort descending.

order_by example

created_at

string

created_ats

Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

created_ats example

2021-01-01T00:00:00Z

string

updated_ats

Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

updated_ats example

2021-01-01T00:00:00Z

string

label_selector

Optional

A query string containing a list of label selector requirements

label_selector example

environment=production

string of array

guids

Optional

Comma-delimited list of process guids to filter by

string of array

types

Optional

Comma-delimited list of process types to filter by

string of array

app_guids

Optional

Comma-delimited list of app guids to filter by

string of array

space_guids

Optional

Comma-delimited list of space guids to filter by

string of array

organization_guids

Optional

Comma-delimited list of organization guids to filter by

---

Authentication

This operation uses the following authentication methods.

oauth

bearer

Responses

200

Hide Details

OK

Returns ProcessList of type(s) application/json

This response body class contains all of the following: Pagination , InlineProcessList1

{
    "total_results": 0,
    "total_pages": 0,
    "first": {
        "href": "string",
        "method": "string"
    },
    "last": {
        "href": "string",
        "method": "string"
    },
    "next": {
        "href": "string",
        "method": "string"
    },
    "previous": {
        "href": "string",
        "method": "string"
    },
    "resources": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "version": "string",
            "type": "string",
            "command": "string",
            "user": "string",
            "instances": 0,
            "memory_in_mb": 0,
            "disk_in_mb": 0,
            "log_rate_limit_in_bytes_per_second": 0,
            "registry_credential_last_synced_at": "string",
            "health_check": {
                "type": "string",
                "data": {
                    "timeout": 0,
                    "invocation_timeout": 0,
                    "interval": 0,
                    "endpoint": "string"
                }
            },
            "readiness_health_check": {
                "type": "string",
                "data": {
                    "timeout": 0,
                    "invocation_timeout": 0,
                    "interval": 0,
                    "endpoint": "string"
                }
            },
            "relationships": {
                "app": {
                    "data": {
                        "guid": "string"
                    }
                },
                "revision": {
                    "data": {
                        "guid": "string"
                    }
                },
                "registry_credential": {
                    "data": {
                        "guid": "string"
                    }
                }
            },
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "scale": {
                    "href": "string",
                    "method": "string"
                },
                "app": {
                    "href": "string",
                    "method": "string"
                },
                "space": {
                    "href": "string",
                    "method": "string"
                },
                "stats": {
                    "href": "string",
                    "method": "string"
                },
                "registry_credential": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ]
}

400

Hide Details

Bad Request

Returns BadRequest of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

401

Hide Details

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

403

Hide Details

Forbidden

Returns Forbidden of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

409

Hide Details

Conflict

Returns Conflict of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

422

Hide Details

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

500

Hide Details

Internal Server Error

Returns 500 of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

502

Hide Details

Bad Gateway

Returns BadGateway of type(s) application/json

{
    "code": 0,
    "detail": "string",
    "title": "string"
}

integer

code

Optional

A numeric code for this error

string

detail

Optional

Detailed description of the error

string

title

Optional

Name of the error

503

Hide Details

Service Unavailable

Returns ServiceUnavailable of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/v3/processes
                

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Processes Operations

GET

List Processes

GET

Get Process

PATCH

Update Process

GET

Get Process Stats

POST

Scale Process

DELETE

Terminate Process Instance

GET

List App Processes

GET

Get Process For App

PATCH

Update Process For App

GET

Get Process Stats For App

POST

Scale Process For App

DELETE

Terminate Process Instance For App