{ "opencollection": "1.0.0", "info": { "name": "Openpath API Documentation auth orgs/relays API", "version": "1.0.0" }, "items": [ { "info": { "name": "orgs/relays", "type": "folder" }, "items": [ { "info": { "name": "List all relays", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/relays", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listRelays" }, { "info": { "name": "Describe a relay", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/relays/:relayId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "relayId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: describeRelay" }, { "info": { "name": "Update a relay", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/relays/:relayId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "relayId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: updateRelay" } ] } ], "bundled": true }