Relay Proxy configurations

The Relay Proxy automatic configuration API provides access to all resources related to relay tokens. To learn more, read Automatic configuration.

List Relay Proxy configs

Get a list of Relay Proxy configurations in the account.

SecurityApiKey

Responses

200

Relay auto config response

401

Invalid access token

403

Forbidden

429

Rate limited

get/api/v2/account/relay-auto-configs

Request samples

curl
Node.js
Python

curl -i -X GET \
  https://app.launchdarkly.com/api/v2/account/relay-auto-configs \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"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 new Relay Proxy config

Create a Relay Proxy config.

SecurityApiKey

Request

Request Body schema: application/json

name required	string A human-friendly name for the Relay Proxy configuration
required	Array of objects (StatementRep)

Responses

201

Relay auto config response

400

Invalid request

401

Invalid access token

429

Rate limited

post/api/v2/account/relay-auto-configs

Request samples

Payload
curl
Node.js
Python

application/json

{"name": "Sample Relay Proxy config for all proj and env",
"policy": [{"actions": ["*"
],
"effect": "allow",
"resources": ["proj/*:env/*"
]
}
]
}

Response samples

application/json

{"_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 Relay Proxy config

Get a single Relay Proxy auto config by ID.

SecurityApiKey

Request

path Parameters

required

string <string>

The relay auto config id

Responses

200

Relay auto config response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/account/relay-auto-configs/{id}

Request samples

curl
Node.js
Python

curl -i -X GET \
  'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"_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

Update a Relay Proxy config.

SecurityApiKey

Request

path Parameters

required

string <string>

The relay auto config id

Request Body schema: application/json

required	Array of objects (JSONPatch)
comment	string

Responses

200

Relay auto config response

400

Invalid request

401

Invalid access token

404

Invalid resource identifier

409

Status conflict

422

Invalid patch content

429

Rate limited

patch/api/v2/account/relay-auto-configs/{id}

Request samples

Payload
curl
Node.js
Python

application/json

{"patch": [{"op": "replace",
"path": "/policy/0",
"value": {"actions": ["*"
],
"effect": "allow",
"resources": ["proj/*:env/qa"
]
}
}
]
}

Response samples

application/json

{"_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 Relay Proxy config by ID

Delete a Relay Proxy config.

SecurityApiKey

Request

path Parameters

required

string <string>

The relay auto config id

Responses

204

Action succeeded

401

Invalid access token

404

Invalid resource identifier

409

Status conflict

429

Rate limited

delete/api/v2/account/relay-auto-configs/{id}

Request samples

curl
Node.js
Python

curl -i -X DELETE \
  'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"code": "unauthorized",
"message": "invalid key"
}

Reset Relay Proxy configuration key

Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.

SecurityApiKey

Request

path Parameters

required

string <string>

The Relay Proxy configuration ID

query Parameters

expiry

integer <int64>

An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately.

Responses

200

Relay auto config response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

post/api/v2/account/relay-auto-configs/{id}/reset

Request samples

curl
Node.js
Python

curl -i -X POST \
  'https://app.launchdarkly.com/api/v2/account/relay-auto-configs/{id}/reset' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"_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
}

➔ Next to Scheduled changes