Chapter 39. Metadata Service
39.1. Metadata Service Copy linkLink copied to clipboard!
39.1.1. GetCentralCapabilities Copy linkLink copied to clipboard!
GET /v1/central-capabilities
39.1.1.1. Description Copy linkLink copied to clipboard!
39.1.1.2. Parameters Copy linkLink copied to clipboard!
39.1.1.3. Return Type Copy linkLink copied to clipboard!
39.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
39.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.1.6. Samples Copy linkLink copied to clipboard!
39.1.2. GetDatabaseBackupStatus Copy linkLink copied to clipboard!
GET /v1/backup/status
39.1.2.1. Description Copy linkLink copied to clipboard!
39.1.2.2. Parameters Copy linkLink copied to clipboard!
39.1.2.3. Return Type Copy linkLink copied to clipboard!
39.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
39.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.2.6. Samples Copy linkLink copied to clipboard!
39.1.3. GetDatabaseStatus Copy linkLink copied to clipboard!
GET /v1/database/status
39.1.3.1. Description Copy linkLink copied to clipboard!
39.1.3.2. Parameters Copy linkLink copied to clipboard!
39.1.3.3. Return Type Copy linkLink copied to clipboard!
39.1.3.4. Content Type Copy linkLink copied to clipboard!
- application/json
39.1.3.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.3.6. Samples Copy linkLink copied to clipboard!
39.1.4. GetMetadata Copy linkLink copied to clipboard!
GET /v1/metadata
39.1.4.1. Description Copy linkLink copied to clipboard!
39.1.4.2. Parameters Copy linkLink copied to clipboard!
39.1.4.3. Return Type Copy linkLink copied to clipboard!
39.1.4.4. Content Type Copy linkLink copied to clipboard!
- application/json
39.1.4.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.4.6. Samples Copy linkLink copied to clipboard!
39.1.5. TLSChallenge Copy linkLink copied to clipboard!
GET /v1/tls-challenge
TLSChallenge
39.1.5.1. Description Copy linkLink copied to clipboard!
Returns all trusted CAs, i.e., secret/additional-ca and Central’s cert chain. This is necessary if Central is running behind a load balancer with self-signed certificates. Does not require authentication.
39.1.5.2. Parameters Copy linkLink copied to clipboard!
39.1.5.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| challengeToken | generated challenge token by the service asking for TLS certs | - | null |
39.1.5.3. Return Type Copy linkLink copied to clipboard!
39.1.5.4. Content Type Copy linkLink copied to clipboard!
- application/json
39.1.5.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |