Relay Proxy configurations

Relay Proxy automatic configuration is an Enterprise feature

Relay Proxy automatic configuration is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

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

Several of the endpoints in the Relay Proxy automatic configuration API require a configuration ID. The Relay Proxy configuration ID is returned as part of the Create a new Relay Proxy config and List Relay Proxy configs responses. It is the _id field, or the _id field of each element in the items array.

List Relay Proxy configs

Get a list of Relay Proxy configurations in the account.

Responses

200

Relay auto configs collection response

401

Invalid access token

403

Forbidden

429

Rate limited

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

Request samples

curl
Node.js
Python

Response samples

application/json

{"items": [{"_id": "string",
"_creator": {"_links": {"self": {"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"_id": "569f183514f4432160000007",
"firstName": "Ariel",
"lastName": "Flores",
"role": "admin",
"email": "ariel@acme.com"
},
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": [null
],
"actions": ["*"
],
"notActions": [null
],
"effect": "string",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": [null
],
"actions": ["*"
],
"notActions": [null
],
"effect": "string",
"role_name": "string"
}
}
]
},
"name": "Relay Proxy Demo Config",
"policy": [{"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string"
}
],
"fullKey": "string",
"displayKey": "7f30",
"creationDate": 0,
"lastModified": 0
}
]
}

Create a new Relay Proxy config

Create a Relay Proxy config.

Request

Request Body schema: application/json

name required	string A human-friendly name for the Relay Proxy configuration
required	Array of objects (Statement) A description of what environments and projects the Relay Proxy should include or exclude. To learn more, read Writing an inline policy.

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": "Ariel",
"lastName": "Flores",
"role": "admin",
"email": "ariel@acme.com"
},
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
]
},
"name": "Relay Proxy Demo Config",
"policy": [{"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string"
}
],
"fullKey": "string",
"displayKey": "7f30",
"creationDate": 0,
"lastModified": 0
}

Get Relay Proxy config

Get a single Relay Proxy auto config by ID.

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

Response samples

application/json

{"_id": "string",
"_creator": {"_links": {"self": {"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"_id": "569f183514f4432160000007",
"firstName": "Ariel",
"lastName": "Flores",
"role": "admin",
"email": "ariel@acme.com"
},
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
]
},
"name": "Relay Proxy Demo Config",
"policy": [{"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string"
}
],
"fullKey": "string",
"displayKey": "7f30",
"creationDate": 0,
"lastModified": 0
}

Update a Relay Proxy config

Update a Relay Proxy config using the JSON patch format.

Request

path Parameters

required

string <string>

The relay auto config id

Request Body schema: application/json

required	Array of objects (JSONPatch)
comment	string Optional comment

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": "Ariel",
"lastName": "Flores",
"role": "admin",
"email": "ariel@acme.com"
},
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
]
},
"name": "Relay Proxy Demo Config",
"policy": [{"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string"
}
],
"fullKey": "string",
"displayKey": "7f30",
"creationDate": 0,
"lastModified": 0
}

Delete Relay Proxy config by ID

Delete a Relay Proxy config.

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

Response samples

application/json

{"code": "unauthorized",
"message": "Invalid access token"
}

Reset Relay Proxy configuration key

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

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

Response samples

application/json

{"_id": "string",
"_creator": {"_links": {"self": {"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"_id": "569f183514f4432160000007",
"firstName": "Ariel",
"lastName": "Flores",
"role": "admin",
"email": "ariel@acme.com"
},
"_access": {"denied": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
],
"allowed": [{"action": "string",
"reason": {"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string",
"role_name": "string"
}
}
]
},
"name": "Relay Proxy Demo Config",
"policy": [{"resources": ["proj/*:env/*;qa_*:/flag/*"
],
"notResources": ["string"
],
"actions": ["*"
],
"notActions": ["string"
],
"effect": "string"
}
],
"fullKey": "string",
"displayKey": "7f30",
"creationDate": 0,
"lastModified": 0
}

➔ Next to Scheduled changes