repository_storage_health.md 1.59 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
# Circuitbreaker API

> [Introduced][ce-11449] in GitLab 9.5.

The Circuitbreaker API is only accessible to administrators. All requests by
guests will respond with `401 Unauthorized`, and all requests by normal users
will respond with `403 Forbidden`.

## Repository Storages

### Get all storage information

Returns of all currently configured storages and their health information.

```
GET /circuit_breakers/repository_storage
```

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage
```

```json
[
  {
    "storage_name": "default",
    "failing_on_hosts": [],
    "total_failures": 0
  },
  {
    "storage_name": "broken",
    "failing_on_hosts": [
      "web01", "worker01"
    ],
    "total_failures": 1
  }
]
```

### Get failing storages

This returns a list of all currently failing storages.

```
GET /circuit_breakers/repository_storage/failing
```

```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage/failing
```

```json
[
    {
        "storage_name":"broken",
        "failing_on_hosts":["web01", "worker01"],
        "total_failures":2
    }
]
```

## Reset failing storage information

Use this remove all failing storage information and allow access to the storage again.

```
DELETE /circuit_breakers/repository_storage
```

```bash
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage
```

[ce-11449]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11449