{ "opencollection": "1.0.0", "info": { "name": "Snyk AccessRequests BrokerContexts API", "version": "REST" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "BrokerContexts", "type": "folder" }, "items": [ { "info": { "name": "List Connection contexts", "type": "http" }, "http": { "method": "GET", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/connections/:connection_id/contexts", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "connection_id", "value": "", "type": "path", "description": "Connection ID" }, { "name": "ending_before", "value": "v1.eyJpZCI6IjExMDAifQo=", "type": "query", "description": "Return the page of results immediately before this cursor" }, { "name": "starting_after", "value": "v1.eyJpZCI6IjEwMDAifQo=", "type": "query", "description": "Return the page of results immediately after this cursor" }, { "name": "limit", "value": "10", "type": "query", "description": "Number of results to return per page" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ] }, "docs": "List Broker contexts for a given broker connection ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`" }, { "info": { "name": "List Connection context", "type": "http" }, "http": { "method": "GET", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/contexts/:context_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "context_id", "value": "", "type": "path", "description": "Context ID" }, { "name": "ending_before", "value": "v1.eyJpZCI6IjExMDAifQo=", "type": "query", "description": "Return the page of results immediately before this cursor" }, { "name": "starting_after", "value": "v1.eyJpZCI6IjEwMDAifQo=", "type": "query", "description": "Return the page of results immediately after this cursor" }, { "name": "limit", "value": "10", "type": "query", "description": "Number of results to return per page" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ] }, "docs": "List Broker context for a given broker context ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`" }, { "info": { "name": "Updates Broker Context", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/contexts/:context_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "context_id", "value": "", "type": "path", "description": "Context ID" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Broker Context for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`" }, { "info": { "name": "Deletes broker context", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/contexts/:context_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "context_id", "value": "", "type": "path", "description": "Context ID" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ] }, "docs": "Deletes an existing broker context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`" }, { "info": { "name": "Updates an integration to be associated with a Broker context", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/contexts/:context_id/integration", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "context_id", "value": "", "type": "path", "description": "Context ID" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an integration to be associated with a Broker context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`" }, { "info": { "name": "Deletes the Broker context association with an Integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/contexts/:context_id/integrations/:integration_id", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "context_id", "value": "", "type": "path", "description": "Context ID" }, { "name": "integration_id", "value": "", "type": "path", "description": "Integration ID" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ] }, "docs": "Deletes an existing Broker context association for an integration\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`" }, { "info": { "name": "List Deployment contexts", "type": "http" }, "http": { "method": "GET", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/deployments/:deployment_id/contexts", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "deployment_id", "value": "", "type": "path", "description": "Deployment ID" }, { "name": "ending_before", "value": "v1.eyJpZCI6IjExMDAifQo=", "type": "query", "description": "Return the page of results immediately before this cursor" }, { "name": "starting_after", "value": "v1.eyJpZCI6IjEwMDAifQo=", "type": "query", "description": "Return the page of results immediately after this cursor" }, { "name": "limit", "value": "10", "type": "query", "description": "Number of results to return per page" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ] }, "docs": "List Deployment contexts for a given deployment ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`" }, { "info": { "name": "Create broker Context", "type": "http" }, "http": { "method": "POST", "url": "https://api.snyk.io/rest/tenants/:tenant_id/brokers/installs/:install_id/deployments/:deployment_id/contexts", "params": [ { "name": "tenant_id", "value": "", "type": "path", "description": "Tenant ID" }, { "name": "install_id", "value": "", "type": "path", "description": "Install ID" }, { "name": "deployment_id", "value": "", "type": "path", "description": "Deployment ID" }, { "name": "version", "value": "2021-06-04", "type": "query", "description": "The requested version of the endpoint to process the request" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Broker Context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`" } ] } ], "bundled": true }