# GetProcess reads one process by its endpoint-scoped resource name.


[API catalog](/reference/api/) · [Docker Sandboxes overview](/reference/api/sandboxes/latest/) · [Product manual](https://docs.docker.com/ai/sandboxes-api/) · [OpenAPI specification](/reference/api/sandboxes/api.yaml)

API version: v1


> This API is experimental. Features, interfaces,
> and behavior may change.




`GET /v1/processes/{process}`

GetProcess reads one process by its endpoint-scoped resource name.

## Connection and access

[API connection and authentication guidance](/reference/api/sandboxes/latest/#authentication)


Server: `{endpoint}`

`endpoint`: The sandbox API base URL from Sandbox.core.endpoint.uri; preserve its path prefix when appending /v1 routes. HTTP endpoints require a scoped endpoint bearer; direct Unix sockets use socket access control.

Effective security: alternatives are OR; schemes within an alternative are AND. An empty array declares no HTTP authentication requirement.

```json
[
  {
    "sandboxBearer": []
  }
]
```

## Example request

Replace placeholders and provide the required credentials or request body.

```console
curl \
  --request GET \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Accept: application/json' \
  'https://sandbox.invalid/v1/processes/<PROCESS>'
```



## Parameters

### process

Location: path. Required: yes.

The process id.

```json
{
  "description": "The process id.",
  "in": "path",
  "name": "process",
  "pointer": "/paths/~1v1~1processes~1{process}/get/parameters/0",
  "required": true,
  "schema": {
    "type": "string"
  }
}
```

## Request and responses

### Response 200 application/json

Success


Schema:

```json
{
  "$ref": "#/components/schemas/Process"
}
```










### Response 404 application/json

The target is absent or not visible within the caller's scope.


Schema:

```json
{
  "$ref": "#/components/schemas/Error"
}
```









notFound:
```json
{
  "code": "notFound",
  "message": "The target is absent or not visible within the caller's scope."
}
```


### Response default application/json

The structured Error body identifies the failure with a stable code and optional typed details.


Schema:

```json
{
  "$ref": "#/components/schemas/Error"
}
```









Schema example:
```json
{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}
```


## Complete operation contract

```json
{
  "description": "GetProcess reads one process by its endpoint-scoped resource name.",
  "operationId": "getProcess",
  "parameters": [
    {
      "description": "The process id.",
      "in": "path",
      "name": "process",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Process"
          }
        }
      },
      "description": "Success"
    },
    "404": {
      "content": {
        "application/json": {
          "examples": {
            "notFound": {
              "summary": "The target is absent or not visible within the caller's scope.",
              "value": {
                "code": "notFound",
                "message": "The target is absent or not visible within the caller's scope."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The target is absent or not visible within the caller's scope."
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "sandboxBearer": []
    }
  ],
  "servers": [
    {
      "url": "{endpoint}",
      "variables": {
        "endpoint": {
          "default": "https://sandbox.invalid",
          "description": "The sandbox API base URL from Sandbox.core.endpoint.uri; preserve its path prefix when appending /v1 routes. HTTP endpoints require a scoped endpoint bearer; direct Unix sockets use socket access control."
        }
      }
    }
  ],
  "summary": "GetProcess reads one process by its endpoint-scoped resource name.",
  "tags": [
    "Processes"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "NOT_FOUND",
      "description": "The target is absent or not visible within the caller's scope."
    }
  ],
  "x-sbx-plane": "data",
  "x-sbx-required-permissions": [
    "sandboxesExec"
  ],
  "x-sbx-serving-surface": "sandboxEndpoint"
}
```

## Referenced schemas

- [#/components/schemas/Error](/reference/api/sandboxes/latest/schemas/Error/)

- [#/components/schemas/Process](/reference/api/sandboxes/latest/schemas/Process/)