The Relay Proxy automatic configuration API provides access to all resources related to relay tokens. To learn more, read Automatic configuration.
Get a list of Relay Proxy configurations in the account.
Relay auto config response
Invalid access token
Forbidden
Rate limited
curl -i -X GET \ https://app.launchdarkly.com/api/v2/account/relay-auto-configs \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "items": [
- {
- "_id": "string",
- "_creator": {
- "_links": {
- "self": {
- "href": "/api/v2/members/569f183514f4432160000007",
- "type": "application/json"
}
}, - "_id": "569f183514f4432160000007",
- "firstName": "An",
- "lastName": "Example",
- "role": "owner",
- "email": "a.example@example.com"
}, - "_access": {
- "denied": [
- {
- "action": "string",
- "reason": {
- "resources": [
- null
], - "notResources": [
- null
], - "actions": [
- null
], - "notActions": [
- null
], - "effect": "string",
- "role_name": "string"
}
}
], - "allowed": [
- {
- "action": "string",
- "reason": {
- "resources": [
- null
], - "notResources": [
- null
], - "actions": [
- null
], - "notActions": [
- null
], - "effect": "string",
- "role_name": "string"
}
}
]
}, - "name": "string",
- "policy": [
- {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string"
}
], - "fullKey": "string",
- "displayKey": "string",
- "creationDate": 0,
- "lastModified": 0
}
]
}
Create a Relay Proxy config.
Relay auto config response
Invalid request
Invalid access token
Rate limited
{- "name": "Sample Relay Proxy config for all proj and env",
- "policy": [
- {
- "actions": [
- "*"
], - "effect": "allow",
- "resources": [
- "proj/*:env/*"
]
}
]
}
{- "_id": "string",
- "_creator": {
- "_links": {
- "self": {
- "href": "/api/v2/members/569f183514f4432160000007",
- "type": "application/json"
}
}, - "_id": "569f183514f4432160000007",
- "firstName": "An",
- "lastName": "Example",
- "role": "owner",
- "email": "a.example@example.com"
}, - "_access": {
- "denied": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
], - "allowed": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
]
}, - "name": "string",
- "policy": [
- {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string"
}
], - "fullKey": "string",
- "displayKey": "string",
- "creationDate": 0,
- "lastModified": 0
}
Get a single Relay Proxy auto config by ID.
Relay auto config response
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
curl -i -X GET \ 'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "_id": "string",
- "_creator": {
- "_links": {
- "self": {
- "href": "/api/v2/members/569f183514f4432160000007",
- "type": "application/json"
}
}, - "_id": "569f183514f4432160000007",
- "firstName": "An",
- "lastName": "Example",
- "role": "owner",
- "email": "a.example@example.com"
}, - "_access": {
- "denied": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
], - "allowed": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
]
}, - "name": "string",
- "policy": [
- {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string"
}
], - "fullKey": "string",
- "displayKey": "string",
- "creationDate": 0,
- "lastModified": 0
}
Update a Relay Proxy config.
Relay auto config response
Invalid request
Invalid access token
Invalid resource identifier
Status conflict
Invalid patch content
Rate limited
{- "patch": [
- {
- "op": "replace",
- "path": "/policy/0",
- "value": {
- "actions": [
- "*"
], - "effect": "allow",
- "resources": [
- "proj/*:env/qa"
]
}
}
]
}
{- "_id": "string",
- "_creator": {
- "_links": {
- "self": {
- "href": "/api/v2/members/569f183514f4432160000007",
- "type": "application/json"
}
}, - "_id": "569f183514f4432160000007",
- "firstName": "An",
- "lastName": "Example",
- "role": "owner",
- "email": "a.example@example.com"
}, - "_access": {
- "denied": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
], - "allowed": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
]
}, - "name": "string",
- "policy": [
- {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string"
}
], - "fullKey": "string",
- "displayKey": "string",
- "creationDate": 0,
- "lastModified": 0
}
Delete a Relay Proxy config.
Action succeeded
Invalid access token
Invalid resource identifier
Status conflict
Rate limited
curl -i -X DELETE \ 'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "code": "unauthorized",
- "message": "invalid key"
}
Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.
Relay auto config response
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
curl -i -X POST \ 'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}/reset' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "_id": "string",
- "_creator": {
- "_links": {
- "self": {
- "href": "/api/v2/members/569f183514f4432160000007",
- "type": "application/json"
}
}, - "_id": "569f183514f4432160000007",
- "firstName": "An",
- "lastName": "Example",
- "role": "owner",
- "email": "a.example@example.com"
}, - "_access": {
- "denied": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
], - "allowed": [
- {
- "action": "string",
- "reason": {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string",
- "role_name": "string"
}
}
]
}, - "name": "string",
- "policy": [
- {
- "resources": [
- "string"
], - "notResources": [
- "string"
], - "actions": [
- "string"
], - "notActions": [
- "string"
], - "effect": "string"
}
], - "fullKey": "string",
- "displayKey": "string",
- "creationDate": 0,
- "lastModified": 0
}