---
type: api
title: Get single agent configuration
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana-serverless/operation/operation-getsingleagentconfiguration
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana-serverless/operation/operation-getsingleagentconfiguration
products:
  - Kibana
---

# Get single agent configuration

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/apm/settings/agent-configuration/view`
- `GET` `/s/{space_id}/api/apm/settings/agent-configuration/view`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana-serverless/authentication#apikeyauth)

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Retrieve a single agent configuration matching the given service name and environment. You must have `read` privileges for the APM and User Experience feature in Kibana. If no matching configuration is found, the API returns a 404.

## Query String Parameters

- `name` (string)
  Service name
- `environment` (string)
  Service environment

## Responses

#### `200`

Successful response

`application/json`

- `id` (string)
- `@timestamp` (number)
  Timestamp
- `agent_name` (string)
  Agent name
- `applied_by_agent` (boolean)
  Applied by agent
- `etag` (string)
  `etag` is sent by the APM agent to indicate the `etag` of the last successfully applied configuration. If the `etag` matches an existing configuration its `applied_by_agent` property will be set to `true`. Every time a configuration is edited `applied_by_agent` is reset to `false`.
- `service` ({})
  Service
  - `environment` (string)
    The environment of the service.
  - `name` (string)
    The name of the service.
- `settings` (object)
  Agent configuration settings
#### `400`

Bad Request response

`application/json`

- `error` (string)
  Error type
- `message` (string)
  Error message
- `statusCode` (number)
  Error status code
#### `401`

Unauthorized response

`application/json`

- `error` (string)
  Error type
- `message` (string)
  Error message
- `statusCode` (number)
  Error status code
#### `404`

Not found response

`application/json`

- `error` (string)
  Error type
- `message` (string)
  Error message
- `statusCode` (number)
  Error status code
## Code Examples

#### Console

```console
GET /api/apm/settings/agent-configuration/view
```

#### curl

```curl
curl -X GET "https://{kibana_url}/api/apm/settings/agent-configuration/view" \
  -H "elastic-api-version: string"
```

## Response Examples

#### Get single agent configuration response example1

An example of a successful response from `GET /api/apm/settings/agent-configuration/view`.

```json
{
  "@timestamp": 1582031336265,
  "agent_name": "nodejs",
  "applied_by_agent": true,
  "etag": "5080ed25785b7b19f32713681e79f46996801a5b",
  "id": "CIaqXXABmQCdPphWj8EJ",
  "service": {
    "environment": "production",
    "name": "frontend"
  },
  "settings": {
    "capture_body": "off",
    "transaction_max_spans": "500",
    "transaction_sample_rate": "0.4"
  }
}
```

#### Bad request

An example of a 400 Bad Request response, returned when the request payload or query parameters fail validation.

```json
{
  "error": "Bad Request",
  "message": "[request body]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}
```

#### Unauthorized

An example of a 401 Unauthorized response, returned when the request is missing valid authentication credentials.

```json
{
  "error": "Unauthorized",
  "message": "[security_exception]: missing authentication credentials for REST request",
  "statusCode": 401
}
```

#### Not found

An example of a 404 Not Found response, returned when the requested resource does not exist or the feature is not available on the current deployment.

```json
{
  "error": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}
```