{ "opencollection": "1.0.0", "info": { "name": "SigNoz alerts role API", "version": "1.0" }, "items": [ { "info": { "name": "role", "type": "folder" }, "items": [ { "info": { "name": "List roles", "type": "http" }, "http": { "method": "GET", "url": "https://{host}:{port}{base_path}/api/v1/roles", "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "This endpoint lists all roles" }, { "info": { "name": "Create role", "type": "http" }, "http": { "method": "POST", "url": "https://{host}:{port}{base_path}/api/v1/roles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "This endpoint creates a role" }, { "info": { "name": "Get role", "type": "http" }, "http": { "method": "GET", "url": "https://{host}:{port}{base_path}/api/v1/roles/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "This endpoint gets a role" }, { "info": { "name": "Patch role", "type": "http" }, "http": { "method": "PATCH", "url": "https://{host}:{port}{base_path}/api/v1/roles/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "This endpoint patches a role" }, { "info": { "name": "Delete role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}:{port}{base_path}/api/v1/roles/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "This endpoint deletes a role" }, { "info": { "name": "Get objects for a role by relation", "type": "http" }, "http": { "method": "GET", "url": "https://{host}:{port}{base_path}/api/v1/roles/:id/relations/:relation/objects", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "relation", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "Gets all objects connected to the specified role via a given relation type" }, { "info": { "name": "Patch objects for a role by relation", "type": "http" }, "http": { "method": "PATCH", "url": "https://{host}:{port}{base_path}/api/v1/roles/:id/relations/:relation/objects", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "relation", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "SigNoz-Api-Key", "value": "{{SigNoz-Api-Key}}", "placement": "header" } }, "docs": "Patches the objects connected to the specified role via a given relation type" } ] } ], "bundled": true }