{ "opencollection": "1.0.0", "info": { "name": "Complete InfluxDB Cloud Authorizations (API tokens) Authorizations (API tokens) Templates API" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Templates", "type": "folder" }, "items": [ { "info": { "name": "List installed stacks", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/stacks", "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n\n#### InfluxDB Cloud\n\n- Doesn't require this parameter;\n InfluxDB only returns resources allowed by the API token.\n" }, { "name": "name", "value": "", "type": "query", "description": "A stack name.\nFinds stack `events` with this name and returns the stacks.\n\nRepeatable.\nTo filter for more than one stack name,\nrepeat this parameter with each name--for example:\n\n- `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1`\n" }, { "name": "stackID", "value": "", "type": "query", "description": "A stack ID.\nOnly returns the specified stack.\n\nRepeatable.\nTo filter for more than one stack ID,\nrepeat this parameter with each ID--for example:\n\n- `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000`\n" } ] }, "docs": "Lists installed InfluxDB stacks.\n\nTo limit stacks in the response, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all installed stacks\nfor the organization.\n\n#### Related guides\n\n- [View InfluxDB stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/).\n" }, { "info": { "name": "Create a stack", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/stacks", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or initializes a stack.\n\nUse this endpoint to _manually_ initialize a new stack with the following\noptional information:\n\n - Stack name\n - Stack description\n - URLs for template manifest files\n\nTo automatically create a stack when applying templates,\nuse the [/api/v2/templates/apply endpoint](#operation/ApplyTemplate).\n\n#### Required permissions\n\n- `write` permission for the organization\n\n#### Related guides\n\n- [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/cloud/" }, { "info": { "name": "Retrieve a stack", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ] }, "docs": "Retrieve a stack" }, { "info": { "name": "Update a stack", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a stack" }, { "info": { "name": "Delete a stack and associated resources", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." }, { "name": "orgID", "value": "", "type": "query", "description": "The identifier of the organization." } ] }, "docs": "Delete a stack and associated resources" }, { "info": { "name": "Uninstall a stack", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/stacks/:stack_id/uninstall", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ] }, "docs": "Uninstall a stack" }, { "info": { "name": "Apply or dry-run a template", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/templates/apply", "body": { "type": "json", "data": "{}" } }, "docs": "Applies a template to\ncreate or update a [stack](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/) of InfluxDB\n[resources](https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/export/all/#resources).\nThe response contains the diff of changes and the stack ID.\n\nUse this endpoint to install an InfluxDB template to an organization.\nProvide template URLs or template objects in your request.\nTo customize which template resources are installed, use the `actions`\nparamet" }, { "info": { "name": "Export a new template", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/templates/export", "body": { "type": "json", "data": "{}" } }, "docs": "Export a new template" } ] } ], "bundled": true }