diff --git a/docs/digitalocean-docs/index.md b/docs/digitalocean-docs/index.md index 0d7b5d8fa1..4e4f510689 100644 --- a/docs/digitalocean-docs/index.md +++ b/docs/digitalocean-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png id: digitalocean-doc slug: /providers/digitalocean - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Cloud computing services and Infrastructure as a Service (IaaS). :::info Provider Summary (v23.04.00139) @@ -49,7 +51,7 @@ REGISTRY PULL digitalocean; The following system environment variables are used for authentication by default: -- `DIGITALOCEAN_ACCESS_TOKEN` - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/)) +- - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -109,4 +111,4 @@ stackql.exe shell --auth=$Auth uptime
vpcs
- \ No newline at end of file + diff --git a/docs/digitalocean-docs/providers/digitalocean/account/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/account/index.md index d9282cff9a..422c037ede 100644 --- a/docs/digitalocean-docs/providers/digitalocean/account/account/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/account/account/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccount
TypeResource
Iddigitalocean.account.account
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `email` | `string` | The email address used by the current user to register for DigitalOcean. | -| `email_verified` | `boolean` | If true, the user has verified their account via email. False otherwise. | -| `floating_ip_limit` | `integer` | The total number of Floating IPs the current user or team may have. | -| `status` | `string` | This value is one of "active", "warning" or "locked". | -| `status_message` | `string` | A human-readable message giving more details about the status of the account. | -| `team` | `object` | When authorized in a team context, includes information about the current team. | -| `uuid` | `string` | The unique universal identifier for the current user. | -| `droplet_limit` | `integer` | The total number of Droplets current user or team may have active at one time. | +| | `integer` | The total number of Droplets current user or team may have active at one time. | +| | `string` | The email address used by the current user to register for DigitalOcean. | +| | `boolean` | If true, the user has verified their account via email. False otherwise. | +| | `integer` | The total number of Floating IPs the current user or team may have. | +| | `string` | This value is one of "active", "warning" or "locked". | +| | `string` | A human-readable message giving more details about the status of the account. | +| | `object` | When authorized in a team context, includes information about the current team. | +| | `string` | The unique universal identifier for the current user. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | | -| `_get` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/account/index.md b/docs/digitalocean-docs/providers/digitalocean/account/index.md index ed9b3d2810..31d078bf91 100644 --- a/docs/digitalocean-docs/providers/digitalocean/account/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/account/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Account :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md index a2d01a36e0..3ff29495e2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/actions/actions/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Iddigitalocean.actions.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | -| `region` | `object` | | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `resource_type` | `string` | The type of resource that the action is associated with. | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `action_id` | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | -| `list` | `SELECT` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. | -| `_get` | `EXEC` | `action_id` | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | -| `_list` | `EXEC` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. | +| | `SELECT` | | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | +| | `SELECT` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. | +| | `EXEC` | | To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. | +| | `EXEC` | | This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. | diff --git a/docs/digitalocean-docs/providers/digitalocean/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/actions/index.md index f95b2c8ab5..3cc8217b1d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/actions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Actions :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md index 132e002f78..9e418f1136 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/alerts/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namealerts
TypeResource
Iddigitalocean.apps.alerts
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `slack_webhooks` | `array` | -| `spec` | `object` | -| `component_name` | `string` | -| `emails` | `array` | -| `phase` | `string` | -| `progress` | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `object` | +| | `array` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_alerts` | `SELECT` | `app_id` | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | -| `_list_alerts` | `EXEC` | `app_id` | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | -| `assign_alertDestinations` | `EXEC` | `alert_id, app_id` | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. | +| | `SELECT` | | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | +| | `EXEC` | | List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions. | +| | `EXEC` | | Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md index 85ae030e28..01ba88d18a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/apps/index.md @@ -14,45 +14,48 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapps
TypeResource
Iddigitalocean.apps.apps
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `project_id` | `string` | | -| `pending_deployment` | `object` | The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment. | -| `domains` | `array` | | -| `live_domain` | `string` | | -| `last_deployment_created_at` | `string` | | -| `tier_slug` | `string` | | -| `region` | `object` | | -| `pinned_deployment` | `object` | The deployment that the app is pinned to. | -| `created_at` | `string` | | -| `active_deployment` | `object` | | -| `in_progress_deployment` | `object` | | -| `default_ingress` | `string` | | -| `owner_uuid` | `string` | | -| `live_url_base` | `string` | | -| `updated_at` | `string` | | -| `live_url` | `string` | | -| `spec` | `object` | The desired configuration of an application. | +| | `string` | | +| | `object` | | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `object` | The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated deployment. | +| | `object` | The deployment that the app is pinned to. | +| | `string` | | +| | `object` | | +| | `object` | The desired configuration of an application. | +| | `string` | | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `id` | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | -| `list` | `SELECT` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | -| `create` | `INSERT` | `data__spec` | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | -| `delete` | `DELETE` | `id` | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. | -| `_get` | `EXEC` | `id` | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | -| `_list` | `EXEC` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | -| `update` | `EXEC` | `id, data__spec` | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | -| `validate_appSpec` | `EXEC` | `data__spec` | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. | +| | `SELECT` | | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | +| | `SELECT` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | +| | `INSERT` | | Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | +| | `DELETE` | | Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time. | +| | `EXEC` | | Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response. | +| | `EXEC` | | List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. | +| | `EXEC` | | Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). | +| | `EXEC` | | To propose and validate a spec for a new or existing app, send a POST request to the `/v2/apps/propose` endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md index 02260b5677..51c384d809 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/daily_metrics_bandwidth/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedaily_metrics_bandwidth
TypeResource
Iddigitalocean.apps.daily_metrics_bandwidth
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `app_bandwidth_usage` | `array` | A list of bandwidth usage details by app. | -| `date` | `string` | The date for the metrics data. | +| | `array` | A list of bandwidth usage details by app. | +| | `string` | The date for the metrics data. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_metrics_bandwidth_daily` | `SELECT` | `app_id` | Retrieve daily bandwidth usage metrics for a single app. | -| `list_metrics_bandwidth_daily` | `EXEC` | `data__app_ids` | Retrieve daily bandwidth usage metrics for multiple apps. | +| | `SELECT` | | Retrieve daily bandwidth usage metrics for a single app. | +| | `EXEC` | | Retrieve daily bandwidth usage metrics for multiple apps. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md index aaf3897b45..7a8206ba12 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/deployments/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeployments
TypeResource
Iddigitalocean.apps.deployments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `cloned_from` | `string` | | -| `phase` | `string` | | -| `created_at` | `string` | | -| `spec` | `object` | The desired configuration of an application. | -| `updated_at` | `string` | | -| `services` | `array` | | -| `cause` | `string` | | -| `static_sites` | `array` | | -| `functions` | `array` | | -| `jobs` | `array` | | -| `progress` | `object` | | -| `tier_slug` | `string` | | -| `phase_last_updated_at` | `string` | | -| `workers` | `array` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `array` | | +| | `array` | | +| | `string` | | +| | `string` | | +| | `object` | | +| | `array` | | +| | `object` | The desired configuration of an application. | +| | `array` | | +| | `string` | | +| | `string` | | +| | `array` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_deployment` | `SELECT` | `app_id, deployment_id` | Retrieve information about an app deployment. | -| `list_deployments` | `SELECT` | `app_id` | List all deployments of an app. | -| `create_deployment` | `INSERT` | `app_id` | Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app. | -| `_get_deployment` | `EXEC` | `app_id, deployment_id` | Retrieve information about an app deployment. | -| `_list_deployments` | `EXEC` | `app_id` | List all deployments of an app. | -| `cancel_deployment` | `EXEC` | `app_id, deployment_id` | Immediately cancel an in-progress deployment. | +| | `SELECT` | | Retrieve information about an app deployment. | +| | `SELECT` | | List all deployments of an app. | +| | `INSERT` | | Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app. | +| | `EXEC` | | Retrieve information about an app deployment. | +| | `EXEC` | | List all deployments of an app. | +| | `EXEC` | | Immediately cancel an in-progress deployment. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/index.md index d086a84887..cdbe55c9a7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Apps :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md index b2884a0840..4ed0852bf1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/instance_sizes/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinstance_sizes
TypeResource
Iddigitalocean.apps.instance_sizes
Id
## Fields | Name | Datatype | |:-----|:---------| -| `name` | `string` | -| `cpu_type` | `string` | -| `usd_per_second` | `string` | -| `tier_downgrade_to` | `string` | -| `tier_slug` | `string` | -| `tier_upgrade_to` | `string` | -| `memory_bytes` | `string` | -| `slug` | `string` | -| `cpus` | `string` | -| `usd_per_month` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_instanceSize` | `SELECT` | `slug` | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | -| `list_instanceSizes` | `SELECT` | | List all instance sizes for `service`, `worker`, and `job` components. | -| `_get_instanceSize` | `EXEC` | `slug` | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | -| `_list_instanceSizes` | `EXEC` | | List all instance sizes for `service`, `worker`, and `job` components. | +| | `SELECT` | | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | +| | `SELECT` | | List all instance sizes for `service`, `worker`, and `job` components. | +| | `EXEC` | | Retrieve information about a specific instance size for `service`, `worker`, and `job` components. | +| | `EXEC` | | List all instance sizes for `service`, `worker`, and `job` components. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md index d2972d5d2c..3b147aee51 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/logs/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelogs
TypeResource
Iddigitalocean.apps.logs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `historic_urls` | `array` | | -| `live_url` | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | +| | `array` | | +| | `string` | A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_logs` | `SELECT` | `app_id, component_name, deployment_id, type` | Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | -| `get_logs_active_deployment` | `SELECT` | `app_id, component_name, type` | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | -| `get_logs_active_deployment_aggregate` | `SELECT` | `app_id, type` | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | -| `get_logs_aggregate` | `SELECT` | `app_id, deployment_id, type` | Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | +| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | +| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | +| | `SELECT` | | Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id. | +| | `SELECT` | | Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md index a7bffd7258..d1ab768a50 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/regions/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameregions
TypeResource
Iddigitalocean.apps.regions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `slug` | `string` | | -| `continent` | `string` | | -| `data_centers` | `array` | | -| `default` | `boolean` | Whether or not the region is presented as the default. | -| `disabled` | `boolean` | | -| `flag` | `string` | | -| `label` | `string` | | -| `reason` | `string` | | +| | `string` | | +| | `array` | | +| | `boolean` | Whether or not the region is presented as the default. | +| | `boolean` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_regions` | `SELECT` | | -| `_list_regions` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md index e08f778c45..b68b88f91a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/rollbacks/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerollbacks
TypeResource
Iddigitalocean.apps.rollbacks
Id
## Fields @@ -29,7 +32,7 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `create_rollback` | `INSERT` | `app_id` | Rollback an app to a previous deployment. A new deployment will be created to perform the rollback.
The app will be pinned to the rollback deployment preventing any new deployments from being created,
either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be
either committed or reverted.

It is recommended to use the Validate App Rollback endpoint to double check if the rollback is
valid and if there are any warnings.
| -| `commit_rollback` | `EXEC` | `app_id` | Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| -| `revert_rollback` | `EXEC` | `app_id` | Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| -| `validate_rollback` | `EXEC` | `app_id` | Check whether an app can be rolled back to a specific deployment. This endpoint can also be used
to check if there are any warnings or validation conditions that will cause the rollback to proceed
under unideal circumstances. For example, if a component must be rebuilt as part of the rollback
causing it to take longer than usual.
| +| | `INSERT` | | Rollback an app to a previous deployment. A new deployment will be created to perform the rollback.
The app will be pinned to the rollback deployment preventing any new deployments from being created,
either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be
either committed or reverted.

It is recommended to use the Validate App Rollback endpoint to double check if the rollback is
valid and if there are any warnings.
| +| | `EXEC` | | Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| +| | `EXEC` | | Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| +| | `EXEC` | | Check whether an app can be rolled back to a specific deployment. This endpoint can also be used
to check if there are any warnings or validation conditions that will cause the rollback to proceed
under unideal circumstances. For example, if a component must be rebuilt as part of the rollback
causing it to take longer than usual.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md b/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md index 95b1820763..7c0555804d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/apps/tiers/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametiers
TypeResource
Iddigitalocean.apps.tiers
Id
## Fields | Name | Datatype | |:-----|:---------| -| `name` | `string` | -| `egress_bandwidth_bytes` | `string` | -| `slug` | `string` | -| `storage_bytes` | `string` | -| `build_seconds` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_tier` | `SELECT` | `slug` | Retrieve information about a specific app tier. | -| `list_tiers` | `SELECT` | | List all app tiers. | -| `_get_tier` | `EXEC` | `slug` | Retrieve information about a specific app tier. | -| `_list_tiers` | `EXEC` | | List all app tiers. | +| | `SELECT` | | Retrieve information about a specific app tier. | +| | `SELECT` | | List all app tiers. | +| | `EXEC` | | Retrieve information about a specific app tier. | +| | `EXEC` | | List all app tiers. | diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md index 04653ca37a..164c54a4b1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/balances/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebalances
TypeResource
Iddigitalocean.billing.balances
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `generated_at` | `string` | The time at which balances were most recently generated. | -| `month_to_date_balance` | `string` | Balance as of the `generated_at` time. This value includes the `account_balance` and `month_to_date_usage`. | -| `month_to_date_usage` | `string` | Amount used in the current billing period as of the `generated_at` time. | -| `account_balance` | `string` | Current balance of the customer's most recent billing activity. Does not reflect `month_to_date_usage`. | +| | `string` | Current balance of the customer's most recent billing activity. Does not reflect `month_to_date_usage`. | +| | `string` | The time at which balances were most recently generated. | +| | `string` | Balance as of the `generated_at` time. This value includes the `account_balance` and `month_to_date_usage`. | +| | `string` | Amount used in the current billing period as of the `generated_at` time. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `balance_get` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md index a00b8fb89e..83c362e8b5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/history/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehistory
TypeResource
Iddigitalocean.billing.history
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `billing_history` | `array` | | -| `links` | `object` | | -| `meta` | `object` | Information about the response itself. | +| | `array` | | +| | `object` | | +| | `object` | Information about the response itself. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `billingHistory_list` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/index.md index dcb645687a..24e0cf893a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Billing :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md index 80ba7e6c61..bf08540ab8 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/invoices/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvoices
TypeResource
Iddigitalocean.billing.invoices
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `invoice_preview` | `object` | The invoice preview. | -| `invoices` | `array` | | -| `links` | `object` | | -| `meta` | `object` | Information about the response itself. | +| | `object` | The invoice preview. | +| | `array` | | +| | `object` | | +| | `object` | Information about the response itself. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_byUUID` | `SELECT` | `invoice_uuid` | To retrieve the invoice items for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`. | -| `list` | `SELECT` | | To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. | -| `get_csvByUUID` | `EXEC` | `invoice_uuid` | To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`. | -| `get_pdfByUUID` | `EXEC` | `invoice_uuid` | To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`. | +| | `SELECT` | | To retrieve the invoice items for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`. | +| | `SELECT` | | To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. | +| | `EXEC` | | To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`. | +| | `EXEC` | | To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md b/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md index 0a6c66ebb9..561005c879 100644 --- a/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/billing/invoices_summary/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvoices_summary
TypeResource
Iddigitalocean.billing.invoices_summary
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `user_company` | `string` | Company of the DigitalOcean customer being invoiced, if set. | -| `user_billing_address` | `object` | The billing address of the customer being invoiced. | -| `amount` | `string` | Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview. | -| `invoice_uuid` | `string` | UUID of the invoice | -| `credits_and_adjustments` | `object` | A summary of the credits and adjustments contributing to the invoice. | -| `product_charges` | `object` | A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the `items` key. | -| `user_name` | `string` | Name of the DigitalOcean customer being invoiced. | -| `taxes` | `object` | A summary of the taxes contributing to the invoice. | -| `overages` | `object` | A summary of the overages contributing to the invoice. | -| `billing_period` | `string` | Billing period of usage for which the invoice is issued, in `YYYY-MM` format. | -| `user_email` | `string` | Email of the DigitalOcean customer being invoiced. | +| | `string` | Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview. | +| | `string` | Billing period of usage for which the invoice is issued, in `YYYY-MM` format. | +| | `object` | A summary of the credits and adjustments contributing to the invoice. | +| | `string` | UUID of the invoice | +| | `object` | A summary of the overages contributing to the invoice. | +| | `object` | A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the `items` key. | +| | `object` | A summary of the taxes contributing to the invoice. | +| | `object` | The billing address of the customer being invoiced. | +| | `string` | Company of the DigitalOcean customer being invoiced, if set. | +| | `string` | Email of the DigitalOcean customer being invoiced. | +| | `string` | Name of the DigitalOcean customer being invoiced. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `invoices_get_summaryByUUID` | `SELECT` | `invoice_uuid` | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md index 482fadf30d..709872d4cf 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Block Storage :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md index b10f47883c..fac9c8b2f9 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_actions/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolume_actions
TypeResource
Iddigitalocean.block_storage.volume_actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `resource_type` | `string` | The type of resource that the action is associated with. | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `action_resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action. | -| `resource_id` | `integer` | | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `region` | `object` | | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| `action_type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `volumeActions_get` | `SELECT` | `action_id, volume_id` | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| -| `volumeActions_list` | `SELECT` | `volume_id` | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| -| `volumeActions_post` | `INSERT` | | To initiate an action on a block storage volume by Name, send a POST request to
`~/v2/volumes/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to five
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|
| -| `_volumeActions_get` | `EXEC` | `action_id, volume_id` | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| -| `_volumeActions_list` | `EXEC` | `volume_id` | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| -| `volumeActions_post_byId` | `EXEC` | `volume_id` | To initiate an action on a block storage volume by Id, send a POST request to
`~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to seven
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

## Resize a Volume

\| Attribute \| Details \|
\| -------------- \| ------------------------------------------------------------------- \|
\| type \| This must be `resize` \|
\| size_gigabytes \| The new size of the block storage volume in GiB (1024^3) \|
\| region \| Set to the slug representing the region where the volume is located \|

Volumes may only be resized upwards. The maximum size for a volume is 16TiB.
| +| | `SELECT` | | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| +| | `SELECT` | | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| +| | `INSERT` | | To initiate an action on a block storage volume by Name, send a POST request to
`~/v2/volumes/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to five
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ----------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| volume_name \| The name of the block storage volume \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|
| +| | `EXEC` | | To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`.

| +| | `EXEC` | | To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`.

| +| | `EXEC` | | To initiate an action on a block storage volume by Id, send a POST request to
`~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate
attributes for the respective action.

## Attach a Block Storage Volume to a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `attach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

Each volume may only be attached to a single Droplet. However, up to seven
volumes may be attached to a Droplet at a time. Pre-formatted volumes will be
automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS
Droplets created on or after April 26, 2018 when attached. On older Droplets,
[additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems)
is required.

## Remove a Block Storage Volume from a Droplet

\| Attribute \| Details \|
\| ---------- \| ------------------------------------------------------------------- \|
\| type \| This must be `detach` \|
\| droplet_id \| Set to the Droplet's ID \|
\| region \| Set to the slug representing the region where the volume is located \|

## Resize a Volume

\| Attribute \| Details \|
\| -------------- \| ------------------------------------------------------------------- \|
\| type \| This must be `resize` \|
\| size_gigabytes \| The new size of the block storage volume in GiB (1024^3) \|
\| region \| Set to the slug representing the region where the volume is located \|

Volumes may only be resized upwards. The maximum size for a volume is 16TiB.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md index cb4445d47d..96ca0aa4e5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volume_snapshots/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolume_snapshots
TypeResource
Iddigitalocean.block_storage.volume_snapshots
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier for the snapshot. | -| `name` | `string` | A human-readable name for the snapshot. | -| `regions` | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | -| `resource_type` | `string` | The type of resource that the snapshot originated from. | -| `tags` | `array` | An array of Tags the snapshot has been tagged with. | -| `resource_id` | `string` | The unique identifier for the resource that the snapshot originated from. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| `size_gigabytes` | `number` | The billable size of the snapshot in gigabytes. | -| `min_disk_size` | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | +| | `string` | The unique identifier for the snapshot. | +| | `string` | A human-readable name for the snapshot. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | +| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | +| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | +| | `string` | The unique identifier for the resource that the snapshot originated from. | +| | `string` | The type of resource that the snapshot originated from. | +| | `number` | The billable size of the snapshot in gigabytes. | +| | `array` | An array of Tags the snapshot has been tagged with. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `volumeSnapshots_get_byId` | `SELECT` | `snapshot_id` | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| -| `volumeSnapshots_list` | `SELECT` | `volume_id` | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| -| `volumeSnapshots_create` | `INSERT` | `volume_id, data__name` | To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. | -| `volumeSnapshots_delete_byId` | `DELETE` | `snapshot_id` | To delete a volume snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| `_volumeSnapshots_get_byId` | `EXEC` | `snapshot_id` | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| -| `_volumeSnapshots_list` | `EXEC` | `volume_id` | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| +| | `SELECT` | | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| +| | `SELECT` | | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| +| | `INSERT` | | To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. | +| | `DELETE` | | To delete a volume snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| +| | `EXEC` | | To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`.

| +| | `EXEC` | | To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`.

| diff --git a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md index 1eb7db0a31..faaa09a871 100644 --- a/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/block_storage/volumes/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolumes
TypeResource
Iddigitalocean.block_storage.volumes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier for the block storage volume. | -| `name` | `string` | A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. | -| `description` | `string` | An optional free-form text field to describe a block storage volume. | -| `filesystem_type` | `string` | The type of filesystem currently in-use on the volume. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the block storage volume was created. | -| `tags` | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | -| `droplet_ids` | `array` | An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet. | -| `region` | `object` | The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned. | -| `filesystem_label` | `string` | The label currently applied to the filesystem. | -| `size_gigabytes` | `integer` | The size of the block storage volume in GiB (1024^3). | +| | `string` | The unique identifier for the block storage volume. | +| | `string` | A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. | +| | `string` | An optional free-form text field to describe a block storage volume. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the block storage volume was created. | +| | `array` | An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet. | +| | `string` | The label currently applied to the filesystem. | +| | `string` | The type of filesystem currently in-use on the volume. | +| | `object` | The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned. | +| | `integer` | The size of the block storage volume in GiB (1024^3). | +| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `volume_id` | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| -| `list` | `SELECT` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| -| `create` | `INSERT` | | To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. | -| `delete` | `DELETE` | `volume_id` | To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| -| `delete_byName` | `DELETE` | | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| -| `_get` | `EXEC` | `volume_id` | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| -| `_list` | `EXEC` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| +| | `SELECT` | | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| +| | `SELECT` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| +| | `INSERT` | | To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. | +| | `DELETE` | | To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| +| | `DELETE` | | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

| +| | `EXEC` | | To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`.

| +| | `EXEC` | | To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`.
## Filtering Results
### By Region
The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1`
### By Name
It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`.
**Note:** You can only create one volume per region with the same name.
### By Name and Region
It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`.


| diff --git a/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md b/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md index 289e5d46d1..e099ded6b5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/cdn/endpoints/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameendpoints
TypeResource
Iddigitalocean.cdn.endpoints
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a CDN endpoint. | -| `origin` | `string` | The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space. | -| `ttl` | `integer` | The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded. | -| `certificate_id` | `string` | The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created. | -| `custom_domain` | `string` | The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. | -| `endpoint` | `string` | The fully qualified domain name (FQDN) from which the CDN-backed content is served. | +| | `string` | A unique ID that can be used to identify and reference a CDN endpoint. | +| | `string` | The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created. | +| | `string` | The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. | +| | `string` | The fully qualified domain name (FQDN) from which the CDN-backed content is served. | +| | `string` | The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space. | +| | `integer` | The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_endpoint` | `SELECT` | `cdn_id` | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | -| `list_endpoints` | `SELECT` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | -| `create_endpoint` | `INSERT` | `data__origin` | To create a new CDN endpoint, send a POST request to `/v2/cdn/endpoints`. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the `ttl`
attribute.

A custom subdomain may be configured by specifying the `custom_domain` and
`certificate_id` attributes.
| -| `delete_endpoint` | `DELETE` | `cdn_id` | To delete a specific CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| `_get_endpoint` | `EXEC` | `cdn_id` | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | -| `_list_endpoints` | `EXEC` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | -| `purge_cache` | `EXEC` | `cdn_id, data__files` | To purge cached content from a CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include
a `files` attribute containing a list of cached file paths to be purged. A
path may be for a single file or may contain a wildcard (`*`) to recursively
purge all files under a directory. When only a wildcard is provided, all
cached files will be purged. There is a rate limit of 50 files per 20 seconds
that can be purged.
| -| `update_endpoints` | `EXEC` | `cdn_id` | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.
| +| | `SELECT` | | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | +| | `SELECT` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | +| | `INSERT` | | To create a new CDN endpoint, send a POST request to `/v2/cdn/endpoints`. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the `ttl`
attribute.

A custom subdomain may be configured by specifying the `custom_domain` and
`certificate_id` attributes.
| +| | `DELETE` | | To delete a specific CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| +| | `EXEC` | | To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. | +| | `EXEC` | | To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. | +| | `EXEC` | | To purge cached content from a CDN endpoint, send a DELETE request to
`/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include
a `files` attribute containing a list of cached file paths to be purged. A
path may be for a single file or may contain a wildcard (`*`) to recursively
purge all files under a directory. When only a wildcard is provided, all
cached files will be purged. There is a rate limit of 50 files per 20 seconds
that can be purged.
| +| | `EXEC` | | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
`/v2/cdn/endpoints/$ENDPOINT_ID`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/cdn/index.md b/docs/digitalocean-docs/providers/digitalocean/cdn/index.md index 0a23488bea..de4d838737 100644 --- a/docs/digitalocean-docs/providers/digitalocean/cdn/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/cdn/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + CDN Endpoints :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md b/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md index b2fae634a5..74f0505911 100644 --- a/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/certificates/certificates/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecertificates
TypeResource
Iddigitalocean.certificates.certificates
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a certificate. | -| `name` | `string` | A unique human-readable name referring to a certificate. | -| `not_after` | `string` | A time value given in ISO8601 combined date and time format that represents the certificate's expiration date. | -| `sha1_fingerprint` | `string` | A unique identifier generated from the SHA-1 fingerprint of the certificate. | -| `state` | `string` | A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`. | -| `type` | `string` | A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the certificate was created. | -| `dns_names` | `array` | An array of fully qualified domain names (FQDNs) for which the certificate was issued. | +| | `string` | A unique ID that can be used to identify and reference a certificate. | +| | `string` | A unique human-readable name referring to a certificate. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the certificate was created. | +| | `array` | An array of fully qualified domain names (FQDNs) for which the certificate was issued. | +| | `string` | A time value given in ISO8601 combined date and time format that represents the certificate's expiration date. | +| | `string` | A unique identifier generated from the SHA-1 fingerprint of the certificate. | +| | `string` | A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`. | +| | `string` | A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `certificate_id` | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | -| `list` | `SELECT` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | -| `create` | `INSERT` | | To upload new SSL certificate which you have previously generated, send a POST
request to `/v2/certificates`.

When uploading a user-generated certificate, the `private_key`,
`leaf_certificate`, and optionally the `certificate_chain` attributes should
be provided. The type must be set to `custom`.

When using Let's Encrypt to create a certificate, the `dns_names` attribute
must be provided, and the type must be set to `lets_encrypt`.
| -| `delete` | `DELETE` | `certificate_id` | To delete a specific certificate, send a DELETE request to
`/v2/certificates/$CERTIFICATE_ID`.
| -| `_get` | `EXEC` | `certificate_id` | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | -| `_list` | `EXEC` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | +| | `SELECT` | | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | +| | `SELECT` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | +| | `INSERT` | | To upload new SSL certificate which you have previously generated, send a POST
request to `/v2/certificates`.

When uploading a user-generated certificate, the `private_key`,
`leaf_certificate`, and optionally the `certificate_chain` attributes should
be provided. The type must be set to `custom`.

When using Let's Encrypt to create a certificate, the `dns_names` attribute
must be provided, and the type must be set to `lets_encrypt`.
| +| | `DELETE` | | To delete a specific certificate, send a DELETE request to
`/v2/certificates/$CERTIFICATE_ID`.
| +| | `EXEC` | | To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. | +| | `EXEC` | | To list all of the certificates available on your account, send a GET request to `/v2/certificates`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/certificates/index.md b/docs/digitalocean-docs/providers/digitalocean/certificates/index.md index 743ad58748..5355069fad 100644 --- a/docs/digitalocean-docs/providers/digitalocean/certificates/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/certificates/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Certificates :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md index bfdb7a2a81..f5a52c21c8 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/container_registry/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontainer_registry
TypeResource
Iddigitalocean.container_registry.container_registry
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. | -| `region` | `string` | Slug of the region where registry data is stored | -| `storage_usage_bytes` | `integer` | The amount of storage used in the registry in bytes. | -| `storage_usage_bytes_updated_at` | `string` | The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. | -| `subscription` | `object` | | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the registry was created. | +| | `string` | A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the registry was created. | +| | `string` | Slug of the region where registry data is stored | +| | `integer` | The amount of storage used in the registry in bytes. | +| | `string` | The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `registry_get` | `SELECT` | | To get information about your container registry, send a GET request to `/v2/registry`. | -| `registry_create` | `INSERT` | `data__name, data__subscription_tier_slug` | To create your container registry, send a POST request to `/v2/registry`.

The `name` becomes part of the URL for images stored in the registry. For
example, if your registry is called `example`, an image in it will have the
URL `registry.digitalocean.com/example/image:tag`.
| -| `registry_delete` | `DELETE` | | To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. | -| `_registry_get` | `EXEC` | | To get information about your container registry, send a GET request to `/v2/registry`. | -| `registry_validate_name` | `EXEC` | `data__name` | To validate that a container registry name is available for use, send a POST
request to `/v2/registry/validate-name`.

If the name is both formatted correctly and available, the response code will
be 204 and contain no body. If the name is already in use, the response will
be a 409 Conflict.
| +| | `SELECT` | | To get information about your container registry, send a GET request to `/v2/registry`. | +| | `INSERT` | | To create your container registry, send a POST request to `/v2/registry`.

The `name` becomes part of the URL for images stored in the registry. For
example, if your registry is called `example`, an image in it will have the
URL `registry.digitalocean.com/example/image:tag`.
| +| | `DELETE` | | To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. | +| | `EXEC` | | To get information about your container registry, send a GET request to `/v2/registry`. | +| | `EXEC` | | To validate that a container registry name is available for use, send a POST
request to `/v2/registry/validate-name`.

If the name is both formatted correctly and available, the response code will
be 204 and contain no body. If the name is already in use, the response will
be a 409 Conflict.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md index 4bb0d60bc4..17c84b76b6 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/digests/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedigests
TypeResource
Iddigitalocean.container_registry.digests
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `compressed_size_bytes` | `integer` | The compressed size of the manifest in bytes. | -| `digest` | `string` | The manifest digest | -| `registry_name` | `string` | The name of the container registry. | -| `repository` | `string` | The name of the repository. | -| `size_bytes` | `integer` | The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available). | -| `tags` | `array` | All tags associated with this manifest | -| `updated_at` | `string` | The time the manifest was last updated. | -| `blobs` | `array` | All blobs associated with this manifest | +| | `array` | All blobs associated with this manifest | +| | `integer` | The compressed size of the manifest in bytes. | +| | `string` | The manifest digest | +| | `string` | The name of the container registry. | +| | `string` | The name of the repository. | +| | `integer` | The uncompressed size of the manifest in bytes (this size is calculated asynchronously so it may not be immediately available). | +| | `array` | All tags associated with this manifest | +| | `string` | The time the manifest was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `registry_list_repositoryManifests` | `SELECT` | `registry_name, repository_name` | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| -| `registry_delete_repositoryManifest` | `DELETE` | `manifest_digest, registry_name, repository_name` | To delete a container repository manifest by digest, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_registry_list_repositoryManifests` | `EXEC` | `registry_name, repository_name` | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| +| | `SELECT` | | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| +| | `DELETE` | | To delete a container repository manifest by digest, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To list all manifests in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list manifests for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/digests`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md index e19b3065af..d0534b6fbf 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/docker_credentials/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedocker_credentials
TypeResource
Iddigitalocean.container_registry.docker_credentials
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `registry_get_dockerCredentials` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md index f54732f506..887e327bf1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/garbage_collection/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegarbage_collection
TypeResource
Iddigitalocean.container_registry.garbage_collection
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `freed_bytes` | `integer` | The number of bytes freed as a result of this garbage collection. | -| `registry_name` | `string` | The name of the container registry. | -| `status` | `string` | The current status of this garbage collection. | -| `updated_at` | `string` | The time the garbage collection was last updated. | -| `uuid` | `string` | A string specifying the UUID of the garbage collection. | -| `blobs_deleted` | `integer` | The number of blobs deleted as a result of this garbage collection. | -| `created_at` | `string` | The time the garbage collection was created. | +| | `integer` | The number of blobs deleted as a result of this garbage collection. | +| | `string` | The time the garbage collection was created. | +| | `integer` | The number of bytes freed as a result of this garbage collection. | +| | `string` | The name of the container registry. | +| | `string` | The current status of this garbage collection. | +| | `string` | The time the garbage collection was last updated. | +| | `string` | A string specifying the UUID of the garbage collection. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `registry_list_garbageCollections` | `SELECT` | `registry_name` | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | -| `_registry_get_garbageCollection` | `EXEC` | `registry_name` | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | -| `_registry_list_garbageCollections` | `EXEC` | `registry_name` | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | -| `registry_get_garbageCollection` | `EXEC` | `registry_name` | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | -| `registry_run_garbageCollection` | `EXEC` | `registry_name` | Garbage collection enables users to clear out unreferenced blobs (layer &
manifest data) after deleting one or more manifests from a repository. If
there are no unreferenced blobs resulting from the deletion of one or more
manifests, garbage collection is effectively a noop.
[See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/)
about how and why you should clean up your container registry periodically.

To request a garbage collection run on your registry, send a POST request to
`/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the
following sequence of events on your registry.

* Set the registry to read-only mode, meaning no further write-scoped
JWTs will be issued to registry clients. Existing write-scoped JWTs will
continue to work until they expire which can take up to 15 minutes.
* Wait until all existing write-scoped JWTs have expired.
* Scan all registry manifests to determine which blobs are unreferenced.
* Delete all unreferenced blobs from the registry.
* Record the number of blobs deleted and bytes freed, mark the garbage
collection status as `success`.
* Remove the read-only mode restriction from the registry, meaning write-scoped
JWTs will once again be issued to registry clients.
| -| `registry_update_garbageCollection` | `EXEC` | `garbage_collection_uuid, registry_name` | To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. | +| | `SELECT` | | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | +| | `EXEC` | | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | +| | `EXEC` | | To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. | +| | `EXEC` | | To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. | +| | `EXEC` | | Garbage collection enables users to clear out unreferenced blobs (layer &
manifest data) after deleting one or more manifests from a repository. If
there are no unreferenced blobs resulting from the deletion of one or more
manifests, garbage collection is effectively a noop.
[See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/)
about how and why you should clean up your container registry periodically.

To request a garbage collection run on your registry, send a POST request to
`/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the
following sequence of events on your registry.

* Set the registry to read-only mode, meaning no further write-scoped
JWTs will be issued to registry clients. Existing write-scoped JWTs will
continue to work until they expire which can take up to 15 minutes.
* Wait until all existing write-scoped JWTs have expired.
* Scan all registry manifests to determine which blobs are unreferenced.
* Delete all unreferenced blobs from the registry.
* Record the number of blobs deleted and bytes freed, mark the garbage
collection status as `success`.
* Remove the read-only mode restriction from the registry, meaning write-scoped
JWTs will once again be issued to registry clients.
| +| | `EXEC` | | To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md index febe7dafb7..995b15b351 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Container Registry :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md index ee26438a5e..0d33e7df1d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/options/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoptions
TypeResource
Iddigitalocean.container_registry.options
Id
## Fields | Name | Datatype | |:-----|:---------| -| `available_regions` | `array` | -| `subscription_tiers` | `array` | +| | `array` | +| | `array` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `registry_get_options` | `SELECT` | | -| `_registry_get_options` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md index 2e15d3c10d..2f1acc428c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerepositories
TypeResource
Iddigitalocean.container_registry.repositories
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the repository. | -| `latest_tag` | `object` | | -| `registry_name` | `string` | The name of the container registry. | -| `tag_count` | `integer` | The number of tags in the repository. | +| | `string` | The name of the repository. | +| | `object` | | +| | `string` | The name of the container registry. | +| | `integer` | The number of tags in the repository. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `registry_list_repositories` | `SELECT` | `registry_name` | -| `_registry_list_repositories` | `EXEC` | `registry_name` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md index f13a167808..e0dbe33505 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/repositories_v2/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerepositories_v2
TypeResource
Iddigitalocean.container_registry.repositories_v2
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the repository. | -| `registry_name` | `string` | The name of the container registry. | -| `tag_count` | `integer` | The number of tags in the repository. | -| `latest_manifest` | `object` | | -| `manifest_count` | `integer` | The number of manifests in the repository. | +| | `string` | The name of the repository. | +| | `object` | | +| | `integer` | The number of manifests in the repository. | +| | `string` | The name of the container registry. | +| | `integer` | The number of tags in the repository. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `registry_list_repositoriesV2` | `SELECT` | `registry_name` | -| `_registry_list_repositoriesV2` | `EXEC` | `registry_name` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md index 50b28b4f51..d0cd135898 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/subscription/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubscription
TypeResource
Iddigitalocean.container_registry.subscription
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `created_at` | `string` | The time at which the subscription was created. | -| `tier` | `object` | | -| `updated_at` | `string` | The time at which the subscription was last updated. | +| | `string` | The time at which the subscription was created. | +| | `object` | | +| | `string` | The time at which the subscription was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `registry_get_subscription` | `SELECT` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | -| `_registry_get_subscription` | `EXEC` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | -| `registry_update_subscription` | `EXEC` | | After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. | +| | `SELECT` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | +| | `EXEC` | | A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. | +| | `EXEC` | | After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md index 4331ea7578..fd4ecd82b7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/container_registry/tags/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Iddigitalocean.container_registry.tags
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `manifest_digest` | `string` | The digest of the manifest associated with the tag. | -| `registry_name` | `string` | The name of the container registry. | -| `repository` | `string` | The name of the repository. | -| `size_bytes` | `integer` | The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). | -| `tag` | `string` | The name of the tag. | -| `updated_at` | `string` | The time the tag was last updated. | -| `compressed_size_bytes` | `integer` | The compressed size of the tag in bytes. | +| | `integer` | The compressed size of the tag in bytes. | +| | `string` | The digest of the manifest associated with the tag. | +| | `string` | The name of the container registry. | +| | `string` | The name of the repository. | +| | `integer` | The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). | +| | `string` | The name of the tag. | +| | `string` | The time the tag was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `registry_list_repositoryTags` | `SELECT` | `registry_name, repository_name` | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| -| `registry_delete_repositoryTag` | `DELETE` | `registry_name, repository_name, repository_tag` | To delete a container repository tag, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo:mytag`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags/mytag`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_registry_list_repositoryTags` | `EXEC` | `registry_name, repository_name` | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| +| | `SELECT` | | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| +| | `DELETE` | | To delete a container repository tag, send a DELETE request to
`/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to delete
`registry.digitalocean.com/example/my/repo:mytag`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags/mytag`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To list all tags in your container registry repository, send a GET
request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`.

Note that if your repository name contains `/` characters, it must be
URL-encoded in the request URL. For example, to list tags for
`registry.digitalocean.com/example/my/repo`, the path would be
`/v2/registry/example/repositories/my%2Frepo/tags`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md index 113bf78e0c..a8c8afb1f4 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/backups/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebackups
TypeResource
Iddigitalocean.databases.backups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `created_at` | `string` | A time value given in ISO8601 combined date and time format at which the backup was created. | -| `size_gigabytes` | `number` | The size of the database backup in GBs. | +| | `string` | A time value given in ISO8601 combined date and time format at which the backup was created. | +| | `number` | The size of the database backup in GBs. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_backups` | `SELECT` | `database_cluster_uuid` | -| `_list_backups` | `EXEC` | `database_cluster_uuid` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md index 9188d69631..a6086215ae 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/ca/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameca
TypeResource
Iddigitalocean.databases.ca
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_ca` | `SELECT` | `database_cluster_uuid` | -| `_get_ca` | `EXEC` | `database_cluster_uuid` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md index aeb5320138..a154e24f25 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/clusters/index.md @@ -14,49 +14,52 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters
TypeResource
Iddigitalocean.databases.clusters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a database cluster. | -| `name` | `string` | A unique, human-readable name referring to a database cluster. | -| `engine` | `string` | A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, and "mongodb" for MongoDB. | -| `size` | `string` | The slug identifier representing the size of the nodes in the database cluster. | -| `version` | `string` | A string representing the version of the database engine in use for the cluster. | -| `version_end_of_availability` | `string` | A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. | -| `rules` | `array` | | -| `project_id` | `string` | The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. | -| `connection` | `object` | | -| `private_connection` | `object` | | -| `maintenance_window` | `object` | | -| `db_names` | `array` | An array of strings containing the names of databases created in the database cluster. | -| `region` | `string` | The slug identifier for the region where the database cluster is located. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | -| `status` | `string` | A string representing the current status of the database cluster. | -| `version_end_of_life` | `string` | A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. | -| `users` | `array` | | -| `tags` | `array` | An array of tags that have been applied to the database cluster. | -| `private_network_uuid` | `string` | A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. | -| `num_nodes` | `integer` | The number of nodes in the database cluster. | +| | `string` | A unique ID that can be used to identify and reference a database cluster. | +| | `string` | A unique, human-readable name referring to a database cluster. | +| | `object` | | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | +| | `array` | An array of strings containing the names of databases created in the database cluster. | +| | `string` | A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, and "mongodb" for MongoDB. | +| | `object` | | +| | `integer` | The number of nodes in the database cluster. | +| | `object` | | +| | `string` | A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. | +| | `string` | The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. | +| | `string` | The slug identifier for the region where the database cluster is located. | +| | `array` | | +| | `string` | The slug identifier representing the size of the nodes in the database cluster. | +| | `string` | A string representing the current status of the database cluster. | +| | `array` | An array of tags that have been applied to the database cluster. | +| | `array` | | +| | `string` | A string representing the version of the database engine in use for the cluster. | +| | `string` | A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. | +| | `string` | A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_cluster` | `SELECT` | `database_cluster_uuid` | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | -| `list_clusters` | `SELECT` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | -| `create_cluster` | `INSERT` | | To create a database cluster, send a POST request to `/v2/databases`.
The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster.
DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel.
Note: Backups are not supported for Redis clusters. | -| `_get_cluster` | `EXEC` | `database_cluster_uuid` | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | -| `_list_clusters` | `EXEC` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | -| `destroy_cluster` | `EXEC` | `database_cluster_uuid` | To destroy a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID`.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | -| `get_evictionPolicy` | `EXEC` | `database_cluster_uuid` | To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`.
The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. | -| `update_clusterSize` | `EXEC` | `database_cluster_uuid, data__num_nodes, data__size` | To resize a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/resize`. The body of the request must specify both the size and num_nodes attributes.
A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed. | -| `update_evictionPolicy` | `EXEC` | `database_cluster_uuid, data__eviction_policy` | To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. | -| `update_maintenanceWindow` | `EXEC` | `database_cluster_uuid, data__day, data__hour` | To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/maintenance`.
A successful request will receive a 204 No Content status code with no body in response. | +| | `SELECT` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | +| | `SELECT` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | +| | `INSERT` | | To create a database cluster, send a POST request to `/v2/databases`.
The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster.
DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel.
Note: Backups are not supported for Redis clusters. | +| | `EXEC` | | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.
The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.
The embedded connection and private_connection objects will contain the information needed to access the database cluster.
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. | +| | `EXEC` | | To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`.
The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes.
The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster:
The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. | +| | `EXEC` | | To destroy a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID`.
A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`.
The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. | +| | `EXEC` | | To resize a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/resize`. The body of the request must specify both the size and num_nodes attributes.
A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed. | +| | `EXEC` | | To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. | +| | `EXEC` | | To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/maintenance`.
A successful request will receive a 204 No Content status code with no body in response. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md index a4c3b71c16..bbc2635bc1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/config/index.md @@ -14,113 +14,116 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfig
TypeResource
Iddigitalocean.databases.config
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `temp_file_limit` | `integer` | PostgreSQL temporary file limit in KiB. If -1, sets to unlimited. | -| `redis_acl_channels_default` | `string` | Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default. | -| `redis_ssl` | `boolean` | Require SSL to access Redis | -| `default_time_zone` | `string` | Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or 'SYSTEM' to use the MySQL server default. | -| `redis_lfu_log_factor` | `integer` | Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies | -| `idle_in_transaction_session_timeout` | `integer` | Time out sessions with open transactions after this number of milliseconds | -| `sql_mode` | `string` | Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas. | -| `redis_timeout` | `integer` | Redis idle connection timeout in seconds | -| `bgwriter_flush_after` | `integer` | The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. | -| `postgres_backup_minute` | `integer` | The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed. | -| `bgwriter_delay` | `integer` | Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms. | -| `max_heap_table_size` | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M) | -| `innodb_ft_min_token_size` | `integer` | The minimum length of words that an InnoDB FULLTEXT index stores. | -| `sql_require_primary_key` | `boolean` | Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them. | -| `backup_hour` | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | -| `stat_monitor_enable` | `boolean` | Enable the pg_stat_monitor extension. <b>Enabling this extension will cause the cluster to be restarted.</b> When this extension is enabled, pg_stat_statements results for utility commands are unreliable. | -| `max_standby_streaming_delay` | `integer` | Max standby streaming delay in milliseconds. | -| `max_worker_processes` | `integer` | Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value. | -| `max_pred_locks_per_transaction` | `integer` | PostgreSQL maximum predicate locks per transaction. | -| `synchronous_replication` | `string` | Synchronous replication type. Note that the service plan also needs to support synchronous replication. | -| `net_read_timeout` | `integer` | The time, in seconds, to wait for more data from an existing connection. aborting the read. | -| `pg_partman_bgw.interval` | `integer` | Sets the time interval to run pg_partman's scheduled tasks. | -| `group_concat_max_len` | `integer` | The maximum permitted result length, in bytes, for the GROUP_CONCAT() function. | -| `net_write_timeout` | `integer` | The number of seconds to wait for a block to be written to a connection before aborting the write. | -| `autovacuum_vacuum_cost_delay` | `integer` | Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds. | -| `autovacuum_naptime` | `integer` | Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute. | -| `max_prepared_transactions` | `integer` | PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value. | -| `innodb_rollback_on_timeout` | `boolean` | When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction. | -| `redis_io_threads` | `integer` | Redis IO thread count | -| `timezone` | `string` | PostgreSQL service timezone | -| `backup_minute` | `integer` | The minute of the backup hour when backup for the service starts. New backup only starts if previous backup has already completed. | -| `log_error_verbosity` | `string` | Controls the amount of detail written in the server log for each message that is logged. | -| `connect_timeout` | `integer` | The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake. | -| `autovacuum_vacuum_threshold` | `integer` | Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples. | -| `slow_query_log` | `boolean` | When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false. | -| `deadlock_timeout` | `integer` | The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. | -| `log_line_prefix` | `string` | Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. | -| `innodb_print_all_deadlocks` | `boolean` | When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default. | -| `autovacuum_vacuum_cost_limit` | `integer` | Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used. | -| `interactive_timeout` | `integer` | The time, in seconds, the server waits for activity on an interactive. connection before closing it. | -| `track_functions` | `string` | Enables tracking of function call counts and time used. | -| `bgwriter_lru_multiplier` | `number` | The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. | -| `pg_partman_bgw.role` | `string` | Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters. | -| `autovacuum_freeze_max_age` | `integer` | Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. | -| `max_wal_senders` | `integer` | PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value. | -| `max_allowed_packet` | `integer` | The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M). | -| `information_schema_stats_expiry` | `integer` | The time, in seconds, before cached statistics expire. | -| `log_min_duration_statement` | `integer` | Log statements that take more than this number of milliseconds to run. If -1, disables. | -| `redis_maxmemory_policy` | `string` | A string specifying the desired eviction policy for the Redis cluster.

- `noeviction`: Don't evict any data, returns error when memory limit is reached.
- `allkeys_lru:` Evict any key, least recently used (LRU) first.
- `allkeys_random`: Evict keys in a random order.
- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.
- `volatile_random`: Evict keys with expiration only in a random order.
- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. | -| `binlog_retention_period` | `number` | The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. | -| `innodb_log_buffer_size` | `integer` | The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk. | -| `track_commit_timestamp` | `string` | Record commit time of transactions. | -| `log_autovacuum_min_duration` | `integer` | Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions. | -| `max_parallel_workers_per_gather` | `integer` | Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. | -| `redis_notify_keyspace_events` | `string` | Set notify-keyspace-events option | -| `redis_number_of_databases` | `integer` | Set number of redis databases. Changing this will cause a restart of redis service. | -| `autovacuum_analyze_scale_factor` | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size). | -| `innodb_ft_server_stopword_table` | `string` | The InnoDB FULLTEXT index stopword list for all InnoDB tables. | -| `autovacuum_analyze_threshold` | `integer` | Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples. | -| `track_activity_query_size` | `integer` | Specifies the number of bytes reserved to track the currently executing command for each active session. | -| `postgres_backup_hour` | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | -| `internal_tmp_mem_storage_engine` | `string` | The storage engine for in-memory internal temporary tables. | -| `innodb_lock_wait_timeout` | `integer` | The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up. | -| `max_replication_slots` | `integer` | PostgreSQL maximum replication slots. | -| `bgwriter_lru_maxpages` | `integer` | The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100. | -| `redis_persistence` | `string` | When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. | -| `timescaledb` | `object` | TimescaleDB extension configuration values | -| `wal_writer_delay` | `integer` | WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance | -| `autovacuum_vacuum_scale_factor` | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size). | -| `max_logical_replication_workers` | `integer` | PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). | -| `long_query_time` | `number` | The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds. | -| `pg_stat_statements.track` | `string` | Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. | -| `autovacuum_max_workers` | `integer` | Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start. | -| `redis_lfu_decay_time` | `integer` | LFU maxmemory-policy counter decay time in minutes | -| `default_toast_compression` | `string` | Specifies the default TOAST compression method for values of compressible columns (the default is lz4). | -| `redis_pubsub_client_output_buffer_limit` | `integer` | Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. | -| `max_stack_depth` | `integer` | Maximum depth of the stack in bytes. | -| `wait_timeout` | `integer` | The number of seconds the server waits for activity on a noninteractive connection before closing it. | -| `tmp_table_size` | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M). | -| `max_standby_archive_delay` | `integer` | Max standby archive delay in milliseconds. | -| `work_mem` | `integer` | The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB). | -| `shared_buffers_percentage` | `number` | Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. | -| `wal_sender_timeout` | `integer` | Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000. | -| `max_files_per_process` | `integer` | PostgreSQL maximum number of files that can be open per process. | -| `jit` | `boolean` | Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT). | -| `max_parallel_workers` | `integer` | Sets the maximum number of workers that the system can support for parallel queries. | -| `max_locks_per_transaction` | `integer` | PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value. | -| `sort_buffer_size` | `integer` | The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K). | -| `track_io_timing` | `string` | Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. | -| `innodb_online_alter_log_max_size` | `integer` | The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables. | -| `pgbouncer` | `object` | PGBouncer connection pooling settings | +| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size). | +| | `integer` | Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples. | +| | `integer` | Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. | +| | `integer` | Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start. | +| | `integer` | Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute. | +| | `integer` | Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds. | +| | `integer` | Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used. | +| | `number` | Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size). | +| | `integer` | Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples. | +| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | The minute of the backup hour when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms. | +| | `integer` | The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback. | +| | `integer` | The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100. | +| | `number` | The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0. | +| | `number` | The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. | +| | `integer` | The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake. | +| | `integer` | The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. | +| | `string` | Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or 'SYSTEM' to use the MySQL server default. | +| | `string` | Specifies the default TOAST compression method for values of compressible columns (the default is lz4). | +| | `integer` | The maximum permitted result length, in bytes, for the GROUP_CONCAT() function. | +| | `integer` | Time out sessions with open transactions after this number of milliseconds | +| | `integer` | The time, in seconds, before cached statistics expire. | +| | `integer` | The minimum length of words that an InnoDB FULLTEXT index stores. | +| | `string` | The InnoDB FULLTEXT index stopword list for all InnoDB tables. | +| | `integer` | The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up. | +| | `integer` | The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk. | +| | `integer` | The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables. | +| | `boolean` | When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default. | +| | `boolean` | When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction. | +| | `integer` | The time, in seconds, the server waits for activity on an interactive. connection before closing it. | +| | `string` | The storage engine for in-memory internal temporary tables. | +| | `boolean` | Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT). | +| | `integer` | Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions. | +| | `string` | Controls the amount of detail written in the server log for each message that is logged. | +| | `string` | Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc. | +| | `integer` | Log statements that take more than this number of milliseconds to run. If -1, disables. | +| | `number` | The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds. | +| | `integer` | The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M). | +| | `integer` | PostgreSQL maximum number of files that can be open per process. | +| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M) | +| | `integer` | PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). | +| | `integer` | Sets the maximum number of workers that the system can support for parallel queries. | +| | `integer` | Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. | +| | `integer` | PostgreSQL maximum predicate locks per transaction. | +| | `integer` | PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | PostgreSQL maximum replication slots. | +| | `integer` | Maximum depth of the stack in bytes. | +| | `integer` | Max standby archive delay in milliseconds. | +| | `integer` | Max standby streaming delay in milliseconds. | +| | `integer` | PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value. | +| | `integer` | The time, in seconds, to wait for more data from an existing connection. aborting the read. | +| | `integer` | The number of seconds to wait for a block to be written to a connection before aborting the write. | +| | `integer` | Sets the time interval to run pg_partman's scheduled tasks. | +| | `string` | Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters. | +| | `string` | Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top. | +| | `object` | PGBouncer connection pooling settings | +| | `integer` | The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. | +| | `integer` | The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed. | +| | `string` | Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default. | +| | `integer` | Redis IO thread count | +| | `integer` | LFU maxmemory-policy counter decay time in minutes | +| | `integer` | Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies | +| | `string` | A string specifying the desired eviction policy for the Redis cluster.

- `noeviction`: Don't evict any data, returns error when memory limit is reached.
- `allkeys_lru:` Evict any key, least recently used (LRU) first.
- `allkeys_random`: Evict keys in a random order.
- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.
- `volatile_random`: Evict keys with expiration only in a random order.
- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. | +| | `string` | Set notify-keyspace-events option | +| | `integer` | Set number of redis databases. Changing this will cause a restart of redis service. | +| | `string` | When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. | +| | `integer` | Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. | +| | `boolean` | Require SSL to access Redis | +| | `integer` | Redis idle connection timeout in seconds | +| | `number` | Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. | +| | `boolean` | When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false. | +| | `integer` | The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K). | +| | `string` | Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas. | +| | `boolean` | Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them. | +| | `boolean` | Enable the pg_stat_monitor extension. <b>Enabling this extension will cause the cluster to be restarted.</b> When this extension is enabled, pg_stat_statements results for utility commands are unreliable. | +| | `string` | Synchronous replication type. Note that the service plan also needs to support synchronous replication. | +| | `integer` | PostgreSQL temporary file limit in KiB. If -1, sets to unlimited. | +| | `object` | TimescaleDB extension configuration values | +| | `string` | PostgreSQL service timezone | +| | `integer` | The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M). | +| | `integer` | Specifies the number of bytes reserved to track the currently executing command for each active session. | +| | `string` | Record commit time of transactions. | +| | `string` | Enables tracking of function call counts and time used. | +| | `string` | Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms. | +| | `integer` | The number of seconds the server waits for activity on a noninteractive connection before closing it. | +| | `integer` | Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000. | +| | `integer` | WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance | +| | `integer` | The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_config` | `SELECT` | `database_cluster_uuid` | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| -| `_get_config` | `EXEC` | `database_cluster_uuid` | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| -| `patch_config` | `EXEC` | `database_cluster_uuid` | To update the configuration for an existing database cluster, send a PATCH request to
`/v2/databases/$DATABASE_ID/config`.
| +| | `SELECT` | | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| +| | `EXEC` | | Shows configuration parameters for an existing database cluster by sending a GET request to
`/v2/databases/$DATABASE_ID/config`.
The response is a JSON object with a `config` key, which is set to an object
containing any database configuration parameters.
| +| | `EXEC` | | To update the configuration for an existing database cluster, send a PATCH request to
`/v2/databases/$DATABASE_ID/config`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md index e19d325e99..66a69f3df5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/connection_pools/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconnection_pools
TypeResource
Iddigitalocean.databases.connection_pools
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | A unique name for the connection pool. Must be between 3 and 60 characters. | -| `mode` | `string` | The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement. | -| `private_connection` | `object` | | -| `size` | `integer` | The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. | -| `user` | `string` | The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. | -| `connection` | `object` | | -| `db` | `string` | The database for use with the connection pool. | +| | `string` | A unique name for the connection pool. Must be between 3 and 60 characters. | +| | `object` | | +| | `string` | The database for use with the connection pool. | +| | `string` | The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement. | +| | `object` | | +| | `integer` | The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster. | +| | `string` | The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_connectionPool` | `SELECT` | `database_cluster_uuid, pool_name` | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | -| `list_connectionPools` | `SELECT` | `database_cluster_uuid` | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | -| `add_connectionPool` | `INSERT` | `database_cluster_uuid, data__db, data__mode, data__name, data__size` | For PostgreSQL database clusters, connection pools can be used to allow a
database to share its idle connections. The popular PostgreSQL connection
pooling utility PgBouncer is used to provide this service. [See here for more information](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/)
about how and why to use PgBouncer connection pooling including
details about the available transaction modes.

To add a new connection pool to a PostgreSQL database cluster, send a POST
request to `/v2/databases/$DATABASE_ID/pools` specifying a name for the pool,
the user to connect with, the database to connect to, as well as its desired
size and transaction mode.
| -| `delete_connectionPool` | `DELETE` | `database_cluster_uuid, pool_name` | To delete a specific connection pool for a PostgreSQL database cluster, send
a DELETE request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| `_get_connectionPool` | `EXEC` | `database_cluster_uuid, pool_name` | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | -| `_list_connectionPools` | `EXEC` | `database_cluster_uuid` | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | -| `update_connectionPool` | `EXEC` | `database_cluster_uuid, pool_name, data__db, data__mode, data__size` | To update a connection pool for a PostgreSQL database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. | +| | `SELECT` | | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | +| | `SELECT` | | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | +| | `INSERT` | | For PostgreSQL database clusters, connection pools can be used to allow a
database to share its idle connections. The popular PostgreSQL connection
pooling utility PgBouncer is used to provide this service. [See here for more information](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/)
about how and why to use PgBouncer connection pooling including
details about the available transaction modes.

To add a new connection pool to a PostgreSQL database cluster, send a POST
request to `/v2/databases/$DATABASE_ID/pools` specifying a name for the pool,
the user to connect with, the database to connect to, as well as its desired
size and transaction mode.
| +| | `DELETE` | | To delete a specific connection pool for a PostgreSQL database cluster, send
a DELETE request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| +| | `EXEC` | | To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`.
The response will be a JSON object with a `pool` key. | +| | `EXEC` | | To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`.
The result will be a JSON object with a `pools` key. This will be set to an array of connection pool objects. | +| | `EXEC` | | To update a connection pool for a PostgreSQL database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md index 7870866e17..84b91c3cd1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/databases/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedatabases
TypeResource
Iddigitalocean.databases.databases
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `database_cluster_uuid, database_name` | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| -| `list` | `SELECT` | `database_cluster_uuid` | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| -| `add` | `INSERT` | `database_cluster_uuid, data__name` | To add a new database to an existing cluster, send a POST request to
`/v2/databases/$DATABASE_ID/dbs`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a key called `db`. The value of this will be
an object that contains the standard attributes associated with a database.
| -| `delete` | `DELETE` | `database_cluster_uuid, database_name` | To delete a specific database, send a DELETE request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: Database management is not supported for Redis clusters.
| -| `_get` | `EXEC` | `database_cluster_uuid, database_name` | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| -| `_list` | `EXEC` | `database_cluster_uuid` | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| +| | `SELECT` | | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| +| | `SELECT` | | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| +| | `INSERT` | | To add a new database to an existing cluster, send a POST request to
`/v2/databases/$DATABASE_ID/dbs`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a key called `db`. The value of this will be
an object that contains the standard attributes associated with a database.
| +| | `DELETE` | | To delete a specific database, send a DELETE request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: Database management is not supported for Redis clusters.
| +| | `EXEC` | | To show information about an existing database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/dbs/$DB_NAME`.

Note: Database management is not supported for Redis clusters.

The response will be a JSON object with a `db` key. This will be set to an object
containing the standard database attributes.
| +| | `EXEC` | | To list all of the databases in a clusters, send a GET request to
`/v2/databases/$DATABASE_ID/dbs`.

The result will be a JSON object with a `dbs` key. This will be set to an array
of database objects, each of which will contain the standard database attributes.

Note: Database management is not supported for Redis clusters.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md index 691d938e7a..7fed58e6cd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/firewall_rules/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewall_rules
TypeResource
Iddigitalocean.databases.firewall_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `uuid` | `string` | A unique ID for the firewall rule itself. | -| `value` | `string` | The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster. | -| `cluster_uuid` | `string` | A unique ID for the database cluster to which the rule is applied. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall rule was created. | -| `type` | `string` | The type of resource that the firewall rule allows to access the database cluster. | +| | `string` | A unique ID for the database cluster to which the rule is applied. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall rule was created. | +| | `string` | The type of resource that the firewall rule allows to access the database cluster. | +| | `string` | A unique ID for the firewall rule itself. | +| | `string` | The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_firewall_rules` | `SELECT` | `database_cluster_uuid` | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | -| `_list_firewall_rules` | `EXEC` | `database_cluster_uuid` | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | -| `update_firewall_rules` | `EXEC` | `database_cluster_uuid` | To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://www.digitalocean.com/docs/networking/vpc/) to limit access to them instead of using a firewall.
A successful | +| | `SELECT` | | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | +| | `EXEC` | | To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to `/v2/databases/$DATABASE_ID/firewall`.
The result will be a JSON object with a `rules` key. | +| | `EXEC` | | To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://www.digitalocean.com/docs/networking/vpc/) to limit access to them instead of using a firewall.
A successful | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/index.md index 836461ae4e..bc6c420030 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Databases :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md index d1866de65e..bd77f07490 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/migrations/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemigrations
TypeResource
Iddigitalocean.databases.migrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the most recent migration. | -| `created_at` | `string` | The time the migration was initiated, in ISO 8601 format. | -| `status` | `string` | The current status of the migration. | +| | `string` | The ID of the most recent migration. | +| | `string` | The time the migration was initiated, in ISO 8601 format. | +| | `string` | The current status of the migration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_migrationStatus` | `SELECT` | `database_cluster_uuid` | To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. | -| `delete_onlineMigration` | `DELETE` | `database_cluster_uuid, migration_id` | To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| -| `update_onlineMigration` | `EXEC` | `database_cluster_uuid` | To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters. | -| `update_region` | `EXEC` | `database_cluster_uuid, data__region` | To migrate a database cluster to a new region, send a `PUT` request to
`/v2/databases/$DATABASE_ID/migrate`. The body of the request must specify a
`region` attribute.

A successful request will receive a 202 Accepted status code with no body in
response. Querying the database cluster will show that its `status` attribute
will now be set to `migrating`. This will transition back to `online` when the
migration has completed.
| +| | `SELECT` | | To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. | +| | `DELETE` | | To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
| +| | `EXEC` | | To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters. | +| | `EXEC` | | To migrate a database cluster to a new region, send a `PUT` request to
`/v2/databases/$DATABASE_ID/migrate`. The body of the request must specify a
`region` attribute.

A successful request will receive a 202 Accepted status code with no body in
response. Querying the database cluster will show that its `status` attribute
will now be set to `migrating`. This will transition back to `online` when the
migration has completed.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md index 9b9de6dcac..a1c36bab2f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/options/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoptions
TypeResource
Iddigitalocean.databases.options
Id
## Fields | Name | Datatype | |:-----|:---------| -| `redis` | `object` | -| `mongodb` | `object` | -| `mysql` | `object` | -| `pg` | `object` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_options` | `SELECT` | | -| `_list_options` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md index 325792d1a1..70bb111d82 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namereplicas
TypeResource
Iddigitalocean.databases.replicas
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a database replica. | -| `name` | `string` | The name to give the read-only replicating | -| `status` | `string` | A string representing the current status of the database cluster. | -| `private_connection` | `object` | | -| `size` | `string` | A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating. | -| `connection` | `object` | | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | -| `private_network_uuid` | `string` | A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region. | -| `region` | `string` | A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster. | -| `tags` | `array` | A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags. | +| | `string` | A unique ID that can be used to identify and reference a database replica. | +| | `string` | The name to give the read-only replicating | +| | `object` | | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the database cluster was created. | +| | `object` | | +| | `string` | A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region. | +| | `string` | A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster. | +| | `string` | A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating. | +| | `string` | A string representing the current status of the database cluster. | +| | `array` | A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_replica` | `SELECT` | `database_cluster_uuid, replica_name` | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | -| `list_replicas` | `SELECT` | `database_cluster_uuid` | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | -| `create_replica` | `INSERT` | `database_cluster_uuid, data__name, data__size` | To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given, the size of the node to be used, and the region where it will be located.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a key called `replica`. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's `status` attribute will be `forking`. When the replica is ready to receive traffic, this will transition to `active`. | -| `_get_replica` | `EXEC` | `database_cluster_uuid, replica_name` | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | -| `_list_replicas` | `EXEC` | `database_cluster_uuid` | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | -| `destroy_replica` | `EXEC` | `database_cluster_uuid, replica_name` | To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | -| `promote_replica` | `EXEC` | `database_cluster_uuid, replica_name` | To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `SELECT` | | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | +| | `SELECT` | | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | +| | `INSERT` | | To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given, the size of the node to be used, and the region where it will be located.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a key called `replica`. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's `status` attribute will be `forking`. When the replica is ready to receive traffic, this will transition to `active`. | +| | `EXEC` | | To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. | +| | `EXEC` | | To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`.

**Note**: Read-only replicas are not supported for Redis clusters.

The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. | +| | `EXEC` | | To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | +| | `EXEC` | | To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`.

**Note**: Read-only replicas are not supported for Redis clusters.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md index f54cc5d156..6ae2e8a7b1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/sql_mode/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesql_mode
TypeResource
Iddigitalocean.databases.sql_mode
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_sql_mode` | `SELECT` | `database_cluster_uuid` | To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`.
The response will be a JSON object with a `sql_mode` key. This will be set to a string representing the configured SQL modes. | -| `update_sql_mode` | `EXEC` | `database_cluster_uuid, data__sql_mode` | To configure the SQL modes for an existing MySQL cluster, send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired modes. See the official MySQL 8 documentation for a [full list of supported SQL modes](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sql-mode-full).
A successful request will receive a 204 No Content status code with no body in response. | +| | `SELECT` | | To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`.
The response will be a JSON object with a `sql_mode` key. This will be set to a string representing the configured SQL modes. | +| | `EXEC` | | To configure the SQL modes for an existing MySQL cluster, send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired modes. See the official MySQL 8 documentation for a [full list of supported SQL modes](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sql-mode-full).
A successful request will receive a 204 No Content status code with no body in response. | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md index e9d3b66e39..adeff632a9 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/upgrade/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameupgrade
TypeResource
Iddigitalocean.databases.upgrade
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `update_major_version` | `EXEC` | `database_cluster_uuid` | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md index 9ae0ee8dd7..81524cd15d 100644 --- a/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Iddigitalocean.databases.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of a database user. | -| `mysql_settings` | `object` | | -| `password` | `string` | A randomly generated password for the database user. | -| `role` | `string` | A string representing the database user's role. The value will be either
"primary" or "normal".
| +| | `string` | The name of a database user. | +| | `object` | | +| | `string` | A randomly generated password for the database user. | +| | `string` | A string representing the database user's role. The value will be either
"primary" or "normal".
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user` | `SELECT` | `database_cluster_uuid, username` | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| -| `list_users` | `SELECT` | `database_cluster_uuid` | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| -| `add_user` | `INSERT` | `database_cluster_uuid, data__name` | To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users`
with the desired username.

Note: User management is not supported for Redis clusters.

When adding a user to a MySQL cluster, additional options can be configured in the
`mysql_settings` object.

The response will be a JSON object with a key called `user`. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| -| `delete_user` | `DELETE` | `database_cluster_uuid, username` | To remove a specific database user, send a DELETE request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: User management is not supported for Redis clusters.
| -| `_get_user` | `EXEC` | `database_cluster_uuid, username` | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| -| `_list_users` | `EXEC` | `database_cluster_uuid` | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| -| `reset_auth` | `EXEC` | `database_cluster_uuid, username` | To reset the password for a database user, send a POST request to
`/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth`.

For `mysql` databases, the authentication method can be specifying by
including a key in the JSON body called `mysql_settings` with the `auth_plugin`
value specified.

The response will be a JSON object with a `user` key. This will be set to an
object containing the standard database user attributes.
| +| | `SELECT` | | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| +| | `SELECT` | | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| +| | `INSERT` | | To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users`
with the desired username.

Note: User management is not supported for Redis clusters.

When adding a user to a MySQL cluster, additional options can be configured in the
`mysql_settings` object.

The response will be a JSON object with a key called `user`. The value of this will be an
object that contains the standard attributes associated with a database user including
its randomly generated password.
| +| | `DELETE` | | To remove a specific database user, send a DELETE request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.

Note: User management is not supported for Redis clusters.
| +| | `EXEC` | | To show information about an existing database user, send a GET request to
`/v2/databases/$DATABASE_ID/users/$USERNAME`.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a `user` key. This will be set to an object
containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings
object.
| +| | `EXEC` | | To list all of the users for your database cluster, send a GET request to
`/v2/databases/$DATABASE_ID/users`.

Note: User management is not supported for Redis clusters.

The result will be a JSON object with a `users` key. This will be set to an array
of database user objects, each of which will contain the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.
| +| | `EXEC` | | To reset the password for a database user, send a POST request to
`/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth`.

For `mysql` databases, the authentication method can be specifying by
including a key in the JSON body called `mysql_settings` with the `auth_plugin`
value specified.

The response will be a JSON object with a `user` key. This will be set to an
object containing the standard database user attributes.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md index dc1abfd5fe..f0789e52ec 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/domains/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Iddigitalocean.domains.domains
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. | -| `ip_address` | `string` | This optional attribute may contain an IP address. When provided, an A record will be automatically created pointing to the apex domain. | -| `ttl` | `integer` | This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | -| `zone_file` | `string` | This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource. | +| | `string` | The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. | +| | `string` | This optional attribute may contain an IP address. When provided, an A record will be automatically created pointing to the apex domain. | +| | `integer` | This value is the time to live for the records on this domain, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | +| | `string` | This attribute contains the complete contents of the zone file for the selected domain. Individual domain record resources should be used to get more granular control over records. However, this attribute can also be used to get information about the SOA record, which is created automatically and is not accessible as an individual record resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `domain_name` | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | -| `list` | `SELECT` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | -| `create` | `INSERT` | | To create a new domain, send a POST request to `/v2/domains`. Set the "name"
attribute to the domain name you are adding. Optionally, you may set the
"ip_address" attribute, and an A record will be automatically created pointing
to the apex domain.
| -| `delete` | `DELETE` | `domain_name` | To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`.
| -| `_get` | `EXEC` | `domain_name` | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | -| `_list` | `EXEC` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | +| | `SELECT` | | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | +| | `SELECT` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | +| | `INSERT` | | To create a new domain, send a POST request to `/v2/domains`. Set the "name"
attribute to the domain name you are adding. Optionally, you may set the
"ip_address" attribute, and an A record will be automatically created pointing
to the apex domain.
| +| | `DELETE` | | To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`.
| +| | `EXEC` | | To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. | +| | `EXEC` | | To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/index.md index b7eaea1186..c657abff53 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Domains :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md b/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md index a7978187cd..6955dee207 100644 --- a/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/domains/records/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerecords
TypeResource
Iddigitalocean.domains.records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique identifier for each domain record. | -| `name` | `string` | The host name, alias, or service being defined by the record. | -| `priority` | `integer` | The priority for SRV and MX records. | -| `data` | `string` | Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates. | -| `type` | `string` | The type of the DNS record. For example: A, CNAME, TXT, ... | -| `flags` | `integer` | An unsigned integer between 0-255 used for CAA records. | -| `ttl` | `integer` | This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | -| `tag` | `string` | The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef" | -| `weight` | `integer` | The weight for SRV records. | -| `port` | `integer` | The port for SRV records. | +| | `integer` | A unique identifier for each domain record. | +| | `string` | The host name, alias, or service being defined by the record. | +| | `string` | Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates. | +| | `integer` | An unsigned integer between 0-255 used for CAA records. | +| | `integer` | The port for SRV records. | +| | `integer` | The priority for SRV and MX records. | +| | `string` | The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef" | +| | `integer` | This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested. | +| | `string` | The type of the DNS record. For example: A, CNAME, TXT, ... | +| | `integer` | The weight for SRV records. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_record` | `SELECT` | `domain_name, domain_record_id` | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | -| `list_records` | `SELECT` | `domain_name` | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| -| `create_record` | `INSERT` | `domain_name` | To create a new record to a domain, send a POST request to
`/v2/domains/$DOMAIN_NAME/records`.

The request must include all of the required fields for the domain record type
being added.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective required attributes.
| -| `delete_record` | `DELETE` | `domain_name, domain_record_id` | To delete a record for a domain, send a DELETE request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.

The record will be deleted and the response status will be a 204. This
indicates a successful request with no body returned.
| -| `_get_record` | `EXEC` | `domain_name, domain_record_id` | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | -| `_list_records` | `EXEC` | `domain_name` | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| -| `patch_record` | `EXEC` | `domain_name, domain_record_id, data__type` | To update an existing record, send a PATCH request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| -| `update_record` | `EXEC` | `domain_name, domain_record_id, data__type` | To update an existing record, send a PUT request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| +| | `SELECT` | | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | +| | `SELECT` | | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| +| | `INSERT` | | To create a new record to a domain, send a POST request to
`/v2/domains/$DOMAIN_NAME/records`.

The request must include all of the required fields for the domain record type
being added.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective required attributes.
| +| | `DELETE` | | To delete a record for a domain, send a DELETE request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`.

The record will be deleted and the response status will be a 204. This
indicates a successful request with no body returned.
| +| | `EXEC` | | To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. | +| | `EXEC` | | To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`.
The list of records returned can be filtered by using the `name` and `type` query parameters. For example, to only include A records for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records?type=A`. `name` must be a fully qualified record name. For example, to only include records matching `sub.example.com`, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. Both name and type may be used together.

| +| | `EXEC` | | To update an existing record, send a PATCH request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| +| | `EXEC` | | To update an existing record, send a PUT request to
`/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. Any attribute valid for
the record type can be set to a new value for the record.

See the [attribute table](#tag/Domain-Records) for details regarding record
types and their respective attributes.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md index 674caa2b7a..0e24d18bbb 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/actions/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Iddigitalocean.droplets.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | -| `resource_type` | `string` | The type of resource that the action is associated with. | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `region` | `object` | | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `dropletActions_get` | `SELECT` | `action_id, droplet_id` | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| -| `dropletActions_list` | `SELECT` | `droplet_id` | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| -| `dropletActions_post` | `INSERT` | `droplet_id` | To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details \|
\| ---------------------------------------- \| ----------- \|
\| <nobr>`enable_backups`</nobr> \| Enables backups for a Droplet \|
\| <nobr>`disable_backups`</nobr> \| Disables backups for a Droplet \|
\| <nobr>`reboot`</nobr> \| Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. \|
\| <nobr>`power_cycle`</nobr> \| Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. \|
\| <nobr>`shutdown`</nobr> \| Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. \|
\| <nobr>`power_off`</nobr> \| Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. \|
\| <nobr>`power_on`</nobr> \| Powers on a Droplet. \|
\| <nobr>`restore`</nobr> \| Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. \|
\| <nobr>`password_reset`</nobr> \| Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. \|
\| <nobr>`resize`</nobr> \| Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. \|
\| <nobr>`rebuild`</nobr> \| Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. \|
\| <nobr>`rename`</nobr> \| Renames a Droplet. \|
\| <nobr>`change_kernel`</nobr> \| Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. \|
\| <nobr>`enable_ipv6`</nobr> \| Enables IPv6 for a Droplet. \|
\| <nobr>`snapshot`</nobr> \| Takes a snapshot of a Droplet. \|
| -| `_dropletActions_get` | `EXEC` | `action_id, droplet_id` | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| -| `_dropletActions_list` | `EXEC` | `droplet_id` | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| -| `dropletActions_post_byTag` | `EXEC` | | Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to `/v2/droplets/actions?tag_name=$TAG_NAME` with
the action arguments.

Only a sub-set of action types are supported:

- `power_cycle`
- `power_on`
- `power_off`
- `shutdown`
- `enable_ipv6`
- `enable_backups`
- `disable_backups`
- `snapshot`
| +| | `SELECT` | | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| +| | `SELECT` | | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| +| | `INSERT` | | To initiate an action on a Droplet send a POST request to
`/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details \|
\| ---------------------------------------- \| ----------- \|
\| <nobr>`enable_backups`</nobr> \| Enables backups for a Droplet \|
\| <nobr>`disable_backups`</nobr> \| Disables backups for a Droplet \|
\| <nobr>`reboot`</nobr> \| Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. \|
\| <nobr>`power_cycle`</nobr> \| Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. \|
\| <nobr>`shutdown`</nobr> \| Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. \|
\| <nobr>`power_off`</nobr> \| Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. \|
\| <nobr>`power_on`</nobr> \| Powers on a Droplet. \|
\| <nobr>`restore`</nobr> \| Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. \|
\| <nobr>`password_reset`</nobr> \| Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. \|
\| <nobr>`resize`</nobr> \| Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. \|
\| <nobr>`rebuild`</nobr> \| Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. \|
\| <nobr>`rename`</nobr> \| Renames a Droplet. \|
\| <nobr>`change_kernel`</nobr> \| Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. \|
\| <nobr>`enable_ipv6`</nobr> \| Enables IPv6 for a Droplet. \|
\| <nobr>`snapshot`</nobr> \| Takes a snapshot of a Droplet. \|
| +| | `EXEC` | | To retrieve a Droplet action, send a GET request to
`/v2/droplets/$DROPLET_ID/actions/$ACTION_ID`.

The response will be a JSON object with a key called `action`. The value will
be a Droplet action object.
| +| | `EXEC` | | To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to `/v2/droplets/$DROPLET_ID/actions`.

The results will be returned as a JSON object with an `actions` key. This will
be set to an array filled with `action` objects containing the standard
`action` attributes.
| +| | `EXEC` | | Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to `/v2/droplets/actions?tag_name=$TAG_NAME` with
the action arguments.

Only a sub-set of action types are supported:

- `power_cycle`
- `power_on`
- `power_off`
- `shutdown`
- `enable_ipv6`
- `enable_backups`
- `disable_backups`
- `snapshot`
| diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md index ab8bc0fcb9..a7e4448bbe 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/backups/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebackups
TypeResource
Iddigitalocean.droplets.backups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique identifier for the snapshot or backup. | -| `name` | `string` | A human-readable name for the snapshot. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| `min_disk_size` | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | -| `regions` | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | -| `size_gigabytes` | `number` | The billable size of the snapshot in gigabytes. | -| `type` | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | +| | `integer` | The unique identifier for the snapshot or backup. | +| | `string` | A human-readable name for the snapshot. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | +| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | +| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | +| | `number` | The billable size of the snapshot in gigabytes. | +| | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_backups` | `SELECT` | `droplet_id` | -| `_list_backups` | `EXEC` | `droplet_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md index d3782430eb..71bb6bc5ff 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/droplets/index.md @@ -14,53 +14,56 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplets
TypeResource
Iddigitalocean.droplets.droplets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | -| `name` | `string` | The human-readable name set for the Droplet instance. | -| `disk` | `integer` | The size of the Droplet's disk in gigabytes. | -| `vpc_uuid` | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | -| `tags` | `array` | An array of Tags the Droplet has been tagged with. | -| `status` | `string` | A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". | -| `networks` | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | -| `size_slug` | `string` | The unique slug identifier for the size of this Droplet. | -| `image` | `object` | | -| `memory` | `integer` | Memory of the Droplet in megabytes. | -| `snapshot_ids` | `array` | An array of snapshot IDs of any snapshots created from the Droplet instance. | -| `features` | `array` | An array of features enabled on this Droplet. | -| `region` | `object` | | -| `vcpus` | `integer` | The number of virtual CPUs. | -| `next_backup_window` | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | -| `backup_ids` | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | -| `locked` | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | -| `kernel` | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| -| `size` | `object` | | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | -| `volume_ids` | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | +| | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | +| | `string` | The human-readable name set for the Droplet instance. | +| | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | +| | `integer` | The size of the Droplet's disk in gigabytes. | +| | `array` | An array of features enabled on this Droplet. | +| | `object` | | +| | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| +| | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | +| | `integer` | Memory of the Droplet in megabytes. | +| | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | +| | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | +| | `object` | | +| | `object` | | +| | `string` | The unique slug identifier for the size of this Droplet. | +| | `array` | An array of snapshot IDs of any snapshots created from the Droplet instance. | +| | `string` | A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". | +| | `array` | An array of Tags the Droplet has been tagged with. | +| | `integer` | The number of virtual CPUs. | +| | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | +| | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `droplet_id` | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| -| `list` | `SELECT` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| -| `create` | `INSERT` | | To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.

A Droplet will be created using the provided information. The response body
will contain a JSON object with a key called `droplet`. The value will be an
object containing the standard attributes for your new Droplet. The response
code, 202 Accepted, does not indicate the success or failure of the operation,
just that the request has been accepted for processing. The `actions` returned
as part of the response's `links` object can be used to check the status
of the Droplet create event.

### Create Multiple Droplets

Creating multiple Droplets is very similar to creating a single Droplet.
Instead of sending `name` as a string, send `names` as an array of strings. A
Droplet will be created for each name you send using the associated
information. Up to ten Droplets may be created this way at a time.

Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array
of `actions` returned as part of the response's `links` object can be used to
check the status of each individual Droplet create event.
| -| `_get` | `EXEC` | `droplet_id` | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| -| `_list` | `EXEC` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| -| `destroy` | `EXEC` | `droplet_id` | To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `destroy_byTag` | `EXEC` | `tag_name` | To delete **all** Droplets assigned to a specific tag, include the `tag_name`
query parameter set to the name of the tag in your DELETE request. For
example, `/v2/droplets?tag_name=$TAG_NAME`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `destroy_retryWithAssociatedResources` | `EXEC` | `droplet_id` | If the status of a request to destroy a Droplet with its associated resources
reported any errors, it can be retried by sending a POST request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry` endpoint.

Only one destroy can be active at a time per Droplet. If a retry is issued
while another destroy is in progress for the Droplet a 409 status code will
be returned. A successful response will include a 202 response code and no
content.
| -| `destroy_withAssociatedResourcesDangerous` | `EXEC` | `X-Dangerous, droplet_id` | To destroy a Droplet along with all of its associated resources, send a DELETE
request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous`
endpoint. The headers of this request must include an `X-Dangerous` key set to
`true`. To preview which resources will be destroyed, first query the
Droplet's associated resources. This operation _can not_ be reverse and should
be used with caution.

A successful response will include a 202 response code and no content. Use the
status endpoint to check on the success or failure of the destruction of the
individual resources.
| -| `destroy_withAssociatedResourcesSelective` | `EXEC` | `droplet_id` | To destroy a Droplet along with a sub-set of its associated resources, send a
DELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective`
endpoint. The JSON body of the request should include `reserved_ips`, `snapshots`, `volumes`,
or `volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed. The IDs can be found by querying the Droplet's
associated resources. Any associated resource not included in the request
will remain and continue to accrue changes on your account.

A successful response will include a 202 response code and no content. Use
the status endpoint to check on the success or failure of the destruction of
the individual resources.
| -| `get_DestroyAssociatedResourcesStatus` | `EXEC` | `droplet_id` | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint.
| -| `list_associatedResources` | `EXEC` | `droplet_id` | To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint.

The response will be a JSON object containing `snapshots`, `volumes`, and
`volume_snapshots` keys. Each will be set to an array of objects containing
information about the associated resources.
| -| `list_neighborsIds` | `EXEC` | | To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`.

The results will be returned as a JSON object with a key of `neighbor_ids`.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| +| | `SELECT` | | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| +| | `SELECT` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| +| | `INSERT` | | To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.

A Droplet will be created using the provided information. The response body
will contain a JSON object with a key called `droplet`. The value will be an
object containing the standard attributes for your new Droplet. The response
code, 202 Accepted, does not indicate the success or failure of the operation,
just that the request has been accepted for processing. The `actions` returned
as part of the response's `links` object can be used to check the status
of the Droplet create event.

### Create Multiple Droplets

Creating multiple Droplets is very similar to creating a single Droplet.
Instead of sending `name` as a string, send `names` as an array of strings. A
Droplet will be created for each name you send using the associated
information. Up to ten Droplets may be created this way at a time.

Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array
of `actions` returned as part of the response's `links` object can be used to
check the status of each individual Droplet create event.
| +| | `EXEC` | | To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
| +| | `EXEC` | | To list all Droplets in your account, send a GET request to `/v2/droplets`.

The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.

### Filtering Results by Tag

It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
| +| | `EXEC` | | To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To delete **all** Droplets assigned to a specific tag, include the `tag_name`
query parameter set to the name of the tag in your DELETE request. For
example, `/v2/droplets?tag_name=$TAG_NAME`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | If the status of a request to destroy a Droplet with its associated resources
reported any errors, it can be retried by sending a POST request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry` endpoint.

Only one destroy can be active at a time per Droplet. If a retry is issued
while another destroy is in progress for the Droplet a 409 status code will
be returned. A successful response will include a 202 response code and no
content.
| +| | `EXEC` | | To destroy a Droplet along with all of its associated resources, send a DELETE
request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous`
endpoint. The headers of this request must include an `X-Dangerous` key set to
`true`. To preview which resources will be destroyed, first query the
Droplet's associated resources. This operation _can not_ be reverse and should
be used with caution.

A successful response will include a 202 response code and no content. Use the
status endpoint to check on the success or failure of the destruction of the
individual resources.
| +| | `EXEC` | | To destroy a Droplet along with a sub-set of its associated resources, send a
DELETE request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective`
endpoint. The JSON body of the request should include `reserved_ips`, `snapshots`, `volumes`,
or `volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed. The IDs can be found by querying the Droplet's
associated resources. Any associated resource not included in the request
will remain and continue to accrue changes on your account.

A successful response will include a 202 response code and no content. Use
the status endpoint to check on the success or failure of the destruction of
the individual resources.
| +| | `EXEC` | | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status` endpoint.
| +| | `EXEC` | | To list the associated billable resources that can be destroyed along with a
Droplet, send a GET request to the
`/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint.

The response will be a JSON object containing `snapshots`, `volumes`, and
`volume_snapshots` keys. Each will be set to an array of objects containing
information about the associated resources.
| +| | `EXEC` | | To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`.

The results will be returned as a JSON object with a key of `neighbor_ids`.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md index 44cd75cbbf..cc55286652 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/firewalls/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls
TypeResource
Iddigitalocean.droplets.firewalls
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a firewall. | -| `name` | `string` | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | -| `tags` | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall was created. | -| `pending_changes` | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | -| `droplet_ids` | `array` | An array containing the IDs of the Droplets assigned to the firewall. | -| `outbound_rules` | `array` | | -| `status` | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | -| `inbound_rules` | `array` | | +| | `string` | A unique ID that can be used to identify and reference a firewall. | +| | `string` | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall was created. | +| | `array` | An array containing the IDs of the Droplets assigned to the firewall. | +| | `array` | | +| | `array` | | +| | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | +| | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | +| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_firewalls` | `SELECT` | `droplet_id` | -| `_list_firewalls` | `EXEC` | `droplet_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/index.md index 1e5cf484c8..aa577036df 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Droplets :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md index 9e8a9c69c5..bf5b90b3dd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/kernels/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekernels
TypeResource
Iddigitalocean.droplets.kernels
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique number used to identify and reference a specific kernel. | -| `name` | `string` | The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question. | -| `version` | `string` | A standard kernel version string representing the version, patch, and release information. | +| | `integer` | A unique number used to identify and reference a specific kernel. | +| | `string` | The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question. | +| | `string` | A standard kernel version string representing the version, patch, and release information. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_kernels` | `SELECT` | `droplet_id` | -| `_list_kernels` | `EXEC` | `droplet_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md index afa6f0baa4..b67f070bd3 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/neighbors/index.md @@ -14,42 +14,45 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameneighbors
TypeResource
Iddigitalocean.droplets.neighbors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | -| `name` | `string` | The human-readable name set for the Droplet instance. | -| `backup_ids` | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | -| `networks` | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | -| `tags` | `array` | An array of Tags the Droplet has been tagged with. | -| `volume_ids` | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | -| `kernel` | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| -| `size_slug` | `string` | The unique slug identifier for the size of this Droplet. | -| `vcpus` | `integer` | The number of virtual CPUs. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | -| `disk` | `integer` | The size of the Droplet's disk in gigabytes. | -| `locked` | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | -| `size` | `object` | | -| `next_backup_window` | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | -| `status` | `string` | A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". | -| `memory` | `integer` | Memory of the Droplet in megabytes. | -| `features` | `array` | An array of features enabled on this Droplet. | -| `snapshot_ids` | `array` | An array of snapshot IDs of any snapshots created from the Droplet instance. | -| `image` | `object` | | -| `vpc_uuid` | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | -| `region` | `object` | | +| | `integer` | A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. | +| | `string` | The human-readable name set for the Droplet instance. | +| | `array` | An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the Droplet was created. | +| | `integer` | The size of the Droplet's disk in gigabytes. | +| | `array` | An array of features enabled on this Droplet. | +| | `object` | | +| | `object` | **Note**: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to `null`.

The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
| +| | `boolean` | A boolean value indicating whether the Droplet has been locked, preventing actions by users. | +| | `integer` | Memory of the Droplet in megabytes. | +| | `object` | The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. | +| | `object` | The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. | +| | `object` | | +| | `object` | | +| | `string` | The unique slug identifier for the size of this Droplet. | +| | `array` | An array of snapshot IDs of any snapshots created from the Droplet instance. | +| | `string` | A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". | +| | `array` | An array of Tags the Droplet has been tagged with. | +| | `integer` | The number of virtual CPUs. | +| | `array` | A flat array including the unique identifier for each Block Storage volume attached to the Droplet. | +| | `string` | A string specifying the UUID of the VPC to which the Droplet is assigned. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_neighbors` | `SELECT` | `droplet_id` | -| `_list_neighbors` | `EXEC` | `droplet_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md index 676023ad5e..40cb5e4fd5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/droplets/snapshots/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesnapshots
TypeResource
Iddigitalocean.droplets.snapshots
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique identifier for the snapshot or backup. | -| `name` | `string` | A human-readable name for the snapshot. | -| `regions` | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | -| `size_gigabytes` | `number` | The billable size of the snapshot in gigabytes. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| `min_disk_size` | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | -| `type` | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | +| | `integer` | The unique identifier for the snapshot or backup. | +| | `string` | A human-readable name for the snapshot. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | +| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | +| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | +| | `number` | The billable size of the snapshot in gigabytes. | +| | `string` | Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_snapshots` | `SELECT` | `droplet_id` | -| `_list_snapshots` | `EXEC` | `droplet_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md index e42b0ac7ac..66164d509c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/droplets/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplets
TypeResource
Iddigitalocean.firewalls.droplets
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `delete_droplets` | `DELETE` | `firewall_id, data__droplet_ids` | To remove a Droplet from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there should
be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `assign_droplets` | `EXEC` | `firewall_id, data__droplet_ids` | To assign a Droplet to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there
should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove a Droplet from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there should
be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `EXEC` | | To assign a Droplet to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/droplets`. In the body of the request, there
should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md index 58d3c53188..070a437797 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/firewalls/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls
TypeResource
Iddigitalocean.firewalls.firewalls
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a firewall. | -| `name` | `string` | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | -| `tags` | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | -| `droplet_ids` | `array` | An array containing the IDs of the Droplets assigned to the firewall. | -| `inbound_rules` | `array` | | -| `status` | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | -| `outbound_rules` | `array` | | -| `pending_changes` | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall was created. | +| | `string` | A unique ID that can be used to identify and reference a firewall. | +| | `string` | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the firewall was created. | +| | `array` | An array containing the IDs of the Droplets assigned to the firewall. | +| | `array` | | +| | `array` | | +| | `array` | An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. | +| | `string` | A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". | +| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `firewall_id` | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | -| `list` | `SELECT` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | -| `create` | `INSERT` | | To create a new firewall, send a POST request to `/v2/firewalls`. The request
must contain at least one inbound or outbound access rule.
| -| `delete` | `DELETE` | `firewall_id` | To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `_get` | `EXEC` | `firewall_id` | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | -| `_list` | `EXEC` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | -| `update` | `EXEC` | `firewall_id, data__name` | To update the configuration of an existing firewall, send a PUT request to
`/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation
of the firewall including existing attributes. **Note that any attributes that
are not provided will be reset to their default values.**
| +| | `SELECT` | | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | +| | `SELECT` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | +| | `INSERT` | | To create a new firewall, send a POST request to `/v2/firewalls`. The request
must contain at least one inbound or outbound access rule.
| +| | `DELETE` | | To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `EXEC` | | To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. | +| | `EXEC` | | To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. | +| | `EXEC` | | To update the configuration of an existing firewall, send a PUT request to
`/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation
of the firewall including existing attributes. **Note that any attributes that
are not provided will be reset to their default values.**
| diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md index 03c044e1c3..295843a2b0 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Firewalls :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md index b9c1468959..692dcb30a7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/rules/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Iddigitalocean.firewalls.rules
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `add_rules` | `INSERT` | `firewall_id` | To add additional access rules to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
inbound_rules and/or outbound_rules attribute containing an array of rules to
be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `delete_rules` | `DELETE` | `firewall_id` | To remove access rules from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
`inbound_rules` and/or `outbound_rules` attribute containing an array of rules
to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To add additional access rules to a firewall, send a POST request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
inbound_rules and/or outbound_rules attribute containing an array of rules to
be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove access rules from a firewall, send a DELETE request to
`/v2/firewalls/$FIREWALL_ID/rules`. The body of the request may include an
`inbound_rules` and/or `outbound_rules` attribute containing an array of rules
to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md index 3fd9720890..f1488b3ce1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/firewalls/tags/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Iddigitalocean.firewalls.tags
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `add_tags` | `INSERT` | `firewall_id, data__tags` | To assign a tag representing a group of Droplets to a firewall, send a POST
request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the request,
there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `delete_tags` | `DELETE` | `firewall_id, data__tags` | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the
request, there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `INSERT` | | To assign a tag representing a group of Droplets to a firewall, send a POST
request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the request,
there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to `/v2/firewalls/$FIREWALL_ID/tags`. In the body of the
request, there should be a `tags` attribute containing a list of tag names.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md index cc1312f94d..e691a10bf6 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/actions/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Iddigitalocean.floating_ips.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | -| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `region` | `object` | | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| `resource_type` | `string` | The type of resource that the action is associated with. | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `floatingIPsAction_get` | `SELECT` | `action_id, floating_ip` | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | -| `floatingIPsAction_list` | `SELECT` | `floating_ip` | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | -| `floatingIPsAction_post` | `INSERT` | `floating_ip` | To initiate an action on a floating IP send a POST request to
`/v2/floating_ips/$FLOATING_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a floating IP to a Droplet
\| `unassign` \| Unassign a floating IP from a Droplet
| -| `_floatingIPsAction_get` | `EXEC` | `action_id, floating_ip` | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | -| `_floatingIPsAction_list` | `EXEC` | `floating_ip` | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | +| | `SELECT` | | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | +| | `INSERT` | | To initiate an action on a floating IP send a POST request to
`/v2/floating_ips/$FLOATING_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a floating IP to a Droplet
\| `unassign` \| Unassign a floating IP from a Droplet
| +| | `EXEC` | | To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. | +| | `EXEC` | | To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md index 4321648cfc..d6982c3d3e 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/floating_ips/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefloating_ips
TypeResource
Iddigitalocean.floating_ips.floating_ips
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `droplet` | `` | The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. | -| `ip` | `string` | The public IP address of the floating IP. It also serves as its identifier. | -| `locked` | `boolean` | A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted. | -| `project_id` | `string` | The UUID of the project to which the reserved IP currently belongs. | -| `region` | `object` | The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned. | +| | `` | The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. | +| | `string` | The public IP address of the floating IP. It also serves as its identifier. | +| | `boolean` | A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted. | +| | `string` | The UUID of the project to which the reserved IP currently belongs. | +| | `object` | The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `floatingIPs_get` | `SELECT` | `floating_ip` | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | -| `floatingIPs_list` | `SELECT` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | -| `floatingIPs_create` | `INSERT` | | On creation, a floating IP must be either assigned to a Droplet or reserved to a region.
* To create a new floating IP assigned to a Droplet, send a POST
request to `/v2/floating_ips` with the `droplet_id` attribute.

* To create a new floating IP reserved to a region, send a POST request to
`/v2/floating_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. | -| `floatingIPs_delete` | `DELETE` | `floating_ip` | To delete a floating IP and remove it from your account, send a DELETE request
to `/v2/floating_ips/$FLOATING_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_floatingIPs_get` | `EXEC` | `floating_ip` | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | -| `_floatingIPs_list` | `EXEC` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | +| | `SELECT` | | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | +| | `SELECT` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | +| | `INSERT` | | On creation, a floating IP must be either assigned to a Droplet or reserved to a region.
* To create a new floating IP assigned to a Droplet, send a POST
request to `/v2/floating_ips` with the `droplet_id` attribute.

* To create a new floating IP reserved to a region, send a POST request to
`/v2/floating_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. | +| | `DELETE` | | To delete a floating IP and remove it from your account, send a DELETE request
to `/v2/floating_ips/$FLOATING_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. | +| | `EXEC` | | To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md index 45b3aa7ad3..682d04dd2e 100644 --- a/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/floating_ips/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Floating IPs :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/index.md index 161db28de5..59afd309a7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/functions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/functions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Functions :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md index fc4f937a59..85ba4770a1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/functions/namespace_triggers/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenamespace_triggers
TypeResource
Iddigitalocean.functions.namespace_triggers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The trigger's unique name within the namespace. | -| `created_at` | `string` | UTC time string. | -| `type` | `string` | String which indicates the type of trigger source like SCHEDULED. | -| `updated_at` | `string` | UTC time string. | -| `scheduled_details` | `object` | Trigger details for SCHEDULED type, where body is optional.
| -| `function` | `string` | Name of function(action) that exists in the given namespace. | -| `is_enabled` | `boolean` | Indicates weather the trigger is paused or unpaused. | -| `namespace` | `string` | A unique string format of UUID with a prefix fn-. | -| `scheduled_runs` | `object` | | +| | `string` | The trigger's unique name within the namespace. | +| | `string` | UTC time string. | +| | `string` | Name of function(action) that exists in the given namespace. | +| | `boolean` | Indicates weather the trigger is paused or unpaused. | +| | `string` | A unique string format of UUID with a prefix fn-. | +| | `object` | Trigger details for SCHEDULED type, where body is optional.
| +| | `object` | | +| | `string` | String which indicates the type of trigger source like SCHEDULED. | +| | `string` | UTC time string. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_trigger` | `SELECT` | `namespace_id, trigger_name` | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | -| `list_triggers` | `SELECT` | `namespace_id` | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | -| `create_trigger` | `INSERT` | `namespace_id, data__function, data__is_enabled, data__name, data__scheduled_details, data__type` | Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers` with the `name`, `function`, `type`, `is_enabled` and `scheduled_details` properties. | -| `delete_trigger` | `DELETE` | `namespace_id, trigger_name` | Deletes the given trigger.
To delete trigger, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`.
A successful deletion returns a 204 response. | -| `_get_trigger` | `EXEC` | `namespace_id, trigger_name` | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | -| `_list_triggers` | `EXEC` | `namespace_id` | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | -| `update_trigger` | `EXEC` | `namespace_id, trigger_name` | Updates the details of the given trigger. To update a trigger, send a PUT request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME` with new values for the `is_enabled ` or `scheduled_details` properties. | +| | `SELECT` | | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | +| | `SELECT` | | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | +| | `INSERT` | | Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers` with the `name`, `function`, `type`, `is_enabled` and `scheduled_details` properties. | +| | `DELETE` | | Deletes the given trigger.
To delete trigger, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`.
A successful deletion returns a 204 response. | +| | `EXEC` | | Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. | +| | `EXEC` | | Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers`. | +| | `EXEC` | | Updates the details of the given trigger. To update a trigger, send a PUT request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME` with new values for the `is_enabled ` or `scheduled_details` properties. | diff --git a/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md index f23508c8ab..87cadb23eb 100644 --- a/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/functions/namespaces/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenamespaces
TypeResource
Iddigitalocean.functions.namespaces
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `uuid` | `string` | The namespace's Universally Unique Identifier. | -| `api_host` | `string` | The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. | -| `created_at` | `string` | UTC time string. | -| `key` | `string` | A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate
a user to use the namespace via `doctl`, DigitalOcean's official CLI. | -| `label` | `string` | The namespace's unique name. | -| `namespace` | `string` | A unique string format of UUID with a prefix fn-. | -| `region` | `string` | The namespace's datacenter region. | -| `updated_at` | `string` | UTC time string. | +| | `string` | The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. | +| | `string` | UTC time string. | +| | `string` | A random alpha numeric string. This key is used in conjunction with the namespace's UUID to authenticate
a user to use the namespace via `doctl`, DigitalOcean's official CLI. | +| | `string` | The namespace's unique name. | +| | `string` | A unique string format of UUID with a prefix fn-. | +| | `string` | The namespace's datacenter region. | +| | `string` | UTC time string. | +| | `string` | The namespace's Universally Unique Identifier. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_namespace` | `SELECT` | `namespace_id` | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | -| `list_namespaces` | `SELECT` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | -| `create_namespace` | `INSERT` | `data__label, data__region` | Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to `/v2/functions/namespaces` with the `region` and `label` properties. | -| `delete_namespace` | `DELETE` | `namespace_id` | Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes.
To delete namespace, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID`.
A successful deletion returns a 204 response. | -| `_get_namespace` | `EXEC` | `namespace_id` | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | -| `_list_namespaces` | `EXEC` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | +| | `SELECT` | | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | +| | `SELECT` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | +| | `INSERT` | | Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to `/v2/functions/namespaces` with the `region` and `label` properties. | +| | `DELETE` | | Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes.
To delete namespace, send a DELETE request to `/v2/functions/namespaces/$NAMESPACE_ID`.
A successful deletion returns a 204 response. | +| | `EXEC` | | Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID` with no parameters. | +| | `EXEC` | | Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to `/v2/functions/namespaces`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md index d65d5be9d0..079d6da623 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/actions/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Iddigitalocean.images.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | -| `region` | `object` | | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `resource_type` | `string` | The type of resource that the action is associated with. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `imageActions_get` | `SELECT` | `action_id, image_id` | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | -| `imageActions_list` | `SELECT` | `image_id` | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | -| `imageActions_post` | `INSERT` | `image_id` | The following actions are available on an Image.

## Convert an Image to a Snapshot

To convert an image, for example, a backup to a snapshot, send a POST request
to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `convert`.

## Transfer an Image

To transfer an image to another region, send a POST request to
`/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `transfer` and set
`region` attribute to the slug identifier of the region you wish to transfer
to.
| -| `_imageActions_get` | `EXEC` | `action_id, image_id` | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | -| `_imageActions_list` | `EXEC` | `image_id` | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | +| | `SELECT` | | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | +| | `INSERT` | | The following actions are available on an Image.

## Convert an Image to a Snapshot

To convert an image, for example, a backup to a snapshot, send a POST request
to `/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `convert`.

## Transfer an Image

To transfer an image to another region, send a POST request to
`/v2/images/$IMAGE_ID/actions`. Set the `type` attribute to `transfer` and set
`region` attribute to the slug identifier of the region you wish to transfer
to.
| +| | `EXEC` | | To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. | +| | `EXEC` | | To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/images/images/index.md b/docs/digitalocean-docs/providers/digitalocean/images/images/index.md index 0cb99a24b9..fd52226411 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/images/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/images/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimages
TypeResource
Iddigitalocean.images.images
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique number that can be used to identify and reference a specific image. | -| `name` | `string` | The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. | -| `description` | `string` | An optional free-form text field to describe an image. | -| `regions` | `array` | This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. | -| `size_gigabytes` | `number` | The size of the image in gigabytes. | -| `error_message` | `string` | A string containing information about errors that may occur when importing
a custom image. | -| `distribution` | `string` | The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. | -| `slug` | `string` | A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. | -| `status` | `string` | A status string indicating the state of a custom image. This may be `NEW`,
`available`, `pending`, `deleted`, or `retired`. | -| `tags` | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the image was created. | -| `min_disk_size` | `integer` | The minimum disk size in GB required for a Droplet to use this image. | -| `public` | `boolean` | This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account. | -| `type` | `string` | Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes). | +| | `integer` | A unique number that can be used to identify and reference a specific image. | +| | `string` | The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. | +| | `string` | An optional free-form text field to describe an image. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the image was created. | +| | `string` | The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. | +| | `string` | A string containing information about errors that may occur when importing
a custom image. | +| | `integer` | The minimum disk size in GB required for a Droplet to use this image. | +| | `boolean` | This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account. | +| | `array` | This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. | +| | `number` | The size of the image in gigabytes. | +| | `string` | A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. | +| | `string` | A status string indicating the state of a custom image. This may be `NEW`,
`available`, `pending`, `deleted`, or `retired`. | +| | `array` | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | +| | `string` | Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `image_id` | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| -| `list` | `SELECT` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| -| `create_custom` | `INSERT` | `data__name, data__region, data__url` | To create a new custom image, send a POST request to /v2/images.
The body must contain a url attribute pointing to a Linux virtual machine
image to be imported into DigitalOcean.
The image must be in the raw, qcow2, vhdx, vdi, or vmdk format.
It may be compressed using gzip or bzip2 and must be smaller than 100 GB after
being decompressed.
| -| `delete` | `DELETE` | `image_id` | To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IMAGE_ID`.
| -| `_get` | `EXEC` | `image_id` | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| -| `_list` | `EXEC` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| -| `update` | `EXEC` | `image_id` | To update an image, send a `PUT` request to `/v2/images/$IMAGE_ID`.
Set the `name` attribute to the new value you would like to use.
For custom images, the `description` and `distribution` attributes may also be updated.
| +| | `SELECT` | | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| +| | `SELECT` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| +| | `INSERT` | | To create a new custom image, send a POST request to /v2/images.
The body must contain a url attribute pointing to a Linux virtual machine
image to be imported into DigitalOcean.
The image must be in the raw, qcow2, vhdx, vdi, or vmdk format.
It may be compressed using gzip or bzip2 and must be smaller than 100 GB after
being decompressed.
| +| | `DELETE` | | To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IMAGE_ID`.
| +| | `EXEC` | | To retrieve information about an image, send a `GET` request to
`/v2/images/$IDENTIFIER`.
| +| | `EXEC` | | To list all of the images available on your account, send a GET request to /v2/images.

## Filtering Results
-----

It's possible to request filtered results by including certain query parameters.

**Image Type**

Either 1-Click Application or OS Distribution images can be filtered by using the `type` query parameter.

> Important: The `type` query parameter does not directly relate to the `type` attribute.

To retrieve only ***distribution*** images, include the `type` query parameter set to distribution, `/v2/images?type=distribution`.

To retrieve only ***application*** images, include the `type` query parameter set to application, `/v2/images?type=application`.

**User Images**

To retrieve only the private images of a user, include the `private` query parameter set to true, `/v2/images?private=true`.

**Tags**

To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`.
| +| | `EXEC` | | To update an image, send a `PUT` request to `/v2/images/$IMAGE_ID`.
Set the `name` attribute to the new value you would like to use.
For custom images, the `description` and `distribution` attributes may also be updated.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/images/index.md b/docs/digitalocean-docs/providers/digitalocean/images/index.md index a627bada78..2642e17808 100644 --- a/docs/digitalocean-docs/providers/digitalocean/images/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/images/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Images :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md index 192e14a1c9..fc505b6b80 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusterlint/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusterlint
TypeResource
Iddigitalocean.kubernetes.clusterlint
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `diagnostics` | `array` | An array of diagnostics reporting potential problems for the given cluster. | -| `requested_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made. | -| `run_id` | `string` | Id of the clusterlint run that can be used later to fetch the diagnostics. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed. | +| | `array` | An array of diagnostics reporting potential problems for the given cluster. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made. | +| | `string` | Id of the clusterlint run that can be used later to fetch the diagnostics. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_clusterLintResults` | `SELECT` | `cluster_id` | To request clusterlint diagnostics for your cluster, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. If the `run_id` query
parameter is provided, then the diagnostics for the specific run is fetched.
By default, the latest results are shown.

To find out how to address clusterlint feedback, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| -| `run_clusterLint` | `EXEC` | `cluster_id` | Clusterlint helps operators conform to Kubernetes best practices around
resources, security and reliability to avoid common problems while operating
or upgrading the clusters.

To request a clusterlint run on your cluster, send a POST request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. This will run all
checks present in the `doks` group by default, if a request body is not
specified. Optionally specify the below attributes.

For information about the available checks, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| +| | `SELECT` | | To request clusterlint diagnostics for your cluster, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. If the `run_id` query
parameter is provided, then the diagnostics for the specific run is fetched.
By default, the latest results are shown.

To find out how to address clusterlint feedback, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| +| | `EXEC` | | Clusterlint helps operators conform to Kubernetes best practices around
resources, security and reliability to avoid common problems while operating
or upgrading the clusters.

To request a clusterlint run on your cluster, send a POST request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint`. This will run all
checks present in the `doks` group by default, if a request body is not
specified. Optionally specify the below attributes.

For information about the available checks, please refer to
[the clusterlint check documentation](https://github.com/digitalocean/clusterlint/blob/master/checks.md).
| diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md index b373417381..ba6723bef4 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/clusters/index.md @@ -14,50 +14,53 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters
TypeResource
Iddigitalocean.kubernetes.clusters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a Kubernetes cluster. | -| `name` | `string` | A human-readable name for a Kubernetes cluster. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created. | -| `status` | `object` | An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster. | -| `vpc_uuid` | `string` | A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. | -| `region` | `string` | The slug identifier for the region where the Kubernetes cluster is located. | -| `cluster_subnet` | `string` | The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation. | -| `version` | `string` | The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. "1.14"), the latest version within it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions. | -| `ha` | `boolean` | A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. | -| `registry_enabled` | `boolean` | A read-only boolean value indicating if a container registry is integrated with the cluster. | -| `tags` | `array` | An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. | -| `auto_upgrade` | `boolean` | A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. | -| `surge_upgrade` | `boolean` | A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. | -| `node_pools` | `array` | An object specifying the details of the worker nodes available to the Kubernetes cluster. | -| `ipv4` | `string` | The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+) | -| `endpoint` | `string` | The base URL of the API server on the Kubernetes master node. | -| `service_subnet` | `string` | The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. | -| `maintenance_policy` | `object` | An object specifying the maintenance window policy for the Kubernetes cluster. | -| `updated_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. | +| | `string` | A unique ID that can be used to identify and reference a Kubernetes cluster. | +| | `string` | A human-readable name for a Kubernetes cluster. | +| | `boolean` | A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. | +| | `string` | The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created. | +| | `string` | The base URL of the API server on the Kubernetes master node. | +| | `boolean` | A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. | +| | `string` | The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+) | +| | `object` | An object specifying the maintenance window policy for the Kubernetes cluster. | +| | `array` | An object specifying the details of the worker nodes available to the Kubernetes cluster. | +| | `string` | The slug identifier for the region where the Kubernetes cluster is located. | +| | `boolean` | A read-only boolean value indicating if a container registry is integrated with the cluster. | +| | `string` | The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. | +| | `object` | An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster. | +| | `boolean` | A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. | +| | `array` | An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. | +| | `string` | The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. "1.14"), the latest version within it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions. | +| | `string` | A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_cluster` | `SELECT` | `cluster_id` | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| -| `list_clusters` | `SELECT` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| -| `create_cluster` | `INSERT` | `data__name, data__node_pools, data__region, data__version` | To create a new Kubernetes cluster, send a POST request to
`/v2/kubernetes/clusters`. The request must contain at least one node pool
with at least one worker.

The request may contain a maintenance window policy describing a time period
when disruptive maintenance tasks may be carried out. Omitting the policy
implies that a window will be chosen automatically. See
[here](https://www.digitalocean.com/docs/kubernetes/how-to/upgrade-cluster/)
for details.
| -| `delete_cluster` | `DELETE` | `cluster_id` | To delete a Kubernetes cluster and all services deployed to it, send a DELETE
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.

A 204 status code with no body will be returned in response to a successful
request.
| -| `_get_cluster` | `EXEC` | `cluster_id` | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| -| `_list_clusters` | `EXEC` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| -| `destroy_associatedResourcesDangerous` | `EXEC` | `cluster_id` | To delete a Kubernetes cluster with all of its associated resources, send a
DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous`.
A 204 status code with no body will be returned in response to a successful request.
| -| `destroy_associatedResourcesSelective` | `EXEC` | `cluster_id` | To delete a Kubernetes cluster along with a subset of its associated resources,
send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective`.

The JSON body of the request should include `load_balancers`, `volumes`, or
`volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed.

The IDs can be found by querying the cluster's associated resources endpoint.
Any associated resource not included in the request will remain and continue
to accrue changes on your account.
| -| `get_kubeconfig` | `EXEC` | `cluster_id` | This endpoint returns a kubeconfig file in YAML format. It can be used to
connect to and administer the cluster using the Kubernetes command line tool,
`kubectl`, or other programs supporting kubeconfig files (e.g., client libraries).

The resulting kubeconfig file uses token-based authentication for clusters
supporting it, and certificate-based authentication otherwise. For a list of
supported versions and more information, see "[How to Connect to a DigitalOcean
Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)".

To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`.

Clusters supporting token-based authentication may define an expiration by
passing a duration in seconds as a query parameter to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS`.
If not set or 0, then the token will have a 7 day expiry. The query parameter
has no impact in certificate-based authentication.
| -| `list_associatedResources` | `EXEC` | `cluster_id` | To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint. | -| `update_cluster` | `EXEC` | `cluster_id, data__name` | To update a Kubernetes cluster, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the
attributes below.
| -| `upgrade_cluster` | `EXEC` | `cluster_id` | To immediately upgrade a Kubernetes cluster to a newer patch release of
Kubernetes, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade`.
The body of the request must specify a version attribute.

Available upgrade versions for a cluster can be fetched from
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`.
| +| | `SELECT` | | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| +| | `SELECT` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| +| | `INSERT` | | To create a new Kubernetes cluster, send a POST request to
`/v2/kubernetes/clusters`. The request must contain at least one node pool
with at least one worker.

The request may contain a maintenance window policy describing a time period
when disruptive maintenance tasks may be carried out. Omitting the policy
implies that a window will be chosen automatically. See
[here](https://www.digitalocean.com/docs/kubernetes/how-to/upgrade-cluster/)
for details.
| +| | `DELETE` | | To delete a Kubernetes cluster and all services deployed to it, send a DELETE
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.

A 204 status code with no body will be returned in response to a successful
request.
| +| | `EXEC` | | To show information about an existing Kubernetes cluster, send a GET request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID`.
| +| | `EXEC` | | To list all of the Kubernetes clusters on your account, send a GET request
to `/v2/kubernetes/clusters`.
| +| | `EXEC` | | To delete a Kubernetes cluster with all of its associated resources, send a
DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous`.
A 204 status code with no body will be returned in response to a successful request.
| +| | `EXEC` | | To delete a Kubernetes cluster along with a subset of its associated resources,
send a DELETE request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective`.

The JSON body of the request should include `load_balancers`, `volumes`, or
`volume_snapshots` keys each set to an array of IDs for the associated
resources to be destroyed.

The IDs can be found by querying the cluster's associated resources endpoint.
Any associated resource not included in the request will remain and continue
to accrue changes on your account.
| +| | `EXEC` | | This endpoint returns a kubeconfig file in YAML format. It can be used to
connect to and administer the cluster using the Kubernetes command line tool,
`kubectl`, or other programs supporting kubeconfig files (e.g., client libraries).

The resulting kubeconfig file uses token-based authentication for clusters
supporting it, and certificate-based authentication otherwise. For a list of
supported versions and more information, see "[How to Connect to a DigitalOcean
Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)".

To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET
request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`.

Clusters supporting token-based authentication may define an expiration by
passing a duration in seconds as a query parameter to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS`.
If not set or 0, then the token will have a 7 day expiry. The query parameter
has no impact in certificate-based authentication.
| +| | `EXEC` | | To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources` endpoint. | +| | `EXEC` | | To update a Kubernetes cluster, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the
attributes below.
| +| | `EXEC` | | To immediately upgrade a Kubernetes cluster to a newer patch release of
Kubernetes, send a POST request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade`.
The body of the request must specify a version attribute.

Available upgrade versions for a cluster can be fetched from
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md index 02cca4d5d3..7883f8a044 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/container_registry/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontainer_registry
TypeResource
Iddigitalocean.kubernetes.container_registry
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `add_registry` | `INSERT` | | To integrate the container registry with Kubernetes clusters, send a POST request to `/v2/kubernetes/registry`. | -| `remove_registry` | `DELETE` | | To remove the container registry from Kubernetes clusters, send a DELETE request to `/v2/kubernetes/registry`. | +| | `INSERT` | | To integrate the container registry with Kubernetes clusters, send a POST request to `/v2/kubernetes/registry`. | +| | `DELETE` | | To remove the container registry from Kubernetes clusters, send a DELETE request to `/v2/kubernetes/registry`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md index 04fe1c2287..77dfaea518 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/credentials/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecredentials
TypeResource
Iddigitalocean.kubernetes.credentials
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `client_key_data` | `string` | A base64 encoding of bytes representing the x509 client key
data for access the cluster. This is only returned for clusters without
support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| -| `expires_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the access token expires. | -| `server` | `string` | The URL used to access the cluster API server. | -| `token` | `string` | An access token used to authenticate with the cluster. This is only returned for clusters with support for token-based authentication. | -| `certificate_authority_data` | `string` | A base64 encoding of bytes representing the certificate authority data for accessing the cluster. | -| `client_certificate_data` | `string` | A base64 encoding of bytes representing the x509 client
certificate data for access the cluster. This is only returned for clusters
without support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| +| | `string` | A base64 encoding of bytes representing the certificate authority data for accessing the cluster. | +| | `string` | A base64 encoding of bytes representing the x509 client
certificate data for access the cluster. This is only returned for clusters
without support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| +| | `string` | A base64 encoding of bytes representing the x509 client key
data for access the cluster. This is only returned for clusters without
support for token-based authentication.

Newly created Kubernetes clusters do not return credentials using
certificate-based authentication. For additional information,
[see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate).
| +| | `string` | A time value given in ISO8601 combined date and time format that represents when the access token expires. | +| | `string` | The URL used to access the cluster API server. | +| | `string` | An access token used to authenticate with the cluster. This is only returned for clusters with support for token-based authentication. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_credentials` | `SELECT` | `cluster_id` | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md index 1fe44c294e..9b9fcbe427 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Kubernetes :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md index e0f2ca0df4..87238af330 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/node_pools/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenode_pools
TypeResource
Iddigitalocean.kubernetes.node_pools
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a specific node pool. | -| `name` | `string` | A human-readable name for the node pool. | -| `size` | `string` | The slug identifier for the type of Droplet used as workers in the node pool. | -| `labels` | `object` | An object containing a set of Kubernetes labels. The keys and are values are both user-defined. | -| `tags` | `array` | An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`. | -| `min_nodes` | `integer` | The minimum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | -| `nodes` | `array` | An object specifying the details of a specific worker node in a node pool. | -| `count` | `integer` | The number of Droplet instances in the node pool. | -| `max_nodes` | `integer` | The maximum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | -| `taints` | `array` | An array of taints to apply to all nodes in a pool. Taints will automatically be applied to all existing nodes and any subsequent nodes added to the pool. When a taint is removed, it is removed from all nodes in the pool. | -| `auto_scale` | `boolean` | A boolean value indicating whether auto-scaling is enabled for this node pool. | +| | `string` | A unique ID that can be used to identify and reference a specific node pool. | +| | `string` | A human-readable name for the node pool. | +| | `boolean` | A boolean value indicating whether auto-scaling is enabled for this node pool. | +| | `integer` | The number of Droplet instances in the node pool. | +| | `object` | An object containing a set of Kubernetes labels. The keys and are values are both user-defined. | +| | `integer` | The maximum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | +| | `integer` | The minimum number of nodes that this node pool can be auto-scaled to. The value will be `0` if `auto_scale` is set to `false`. | +| | `array` | An object specifying the details of a specific worker node in a node pool. | +| | `string` | The slug identifier for the type of Droplet used as workers in the node pool. | +| | `array` | An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`. | +| | `array` | An array of taints to apply to all nodes in a pool. Taints will automatically be applied to all existing nodes and any subsequent nodes added to the pool. When a taint is removed, it is removed from all nodes in the pool. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_nodePool` | `SELECT` | `cluster_id, node_pool_id` | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| -| `list_nodePools` | `SELECT` | `cluster_id` | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| -| `add_nodePool` | `INSERT` | `cluster_id, data__count, data__name, data__size` | To add an additional node pool to a Kubernetes clusters, send a POST request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools` with the following
attributes.
| -| `delete_nodePool` | `DELETE` | `cluster_id, node_pool_id` | To delete a node pool, send a DELETE request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.

A 204 status code with no body will be returned in response to a successful
request. Nodes in the pool will subsequently be drained and deleted.
| -| `_get_nodePool` | `EXEC` | `cluster_id, node_pool_id` | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| -| `_list_nodePools` | `EXEC` | `cluster_id` | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| -| `recycle_node_pool` | `EXEC` | `cluster_id, node_pool_id` | The endpoint has been deprecated. Please use the DELETE
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID`
method instead.
| -| `update_nodePool` | `EXEC` | `cluster_id, node_pool_id, data__count, data__name` | To update the name of a node pool, edit the tags applied to it, or adjust its
number of nodes, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID` with the
following attributes.
| +| | `SELECT` | | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| +| | `SELECT` | | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| +| | `INSERT` | | To add an additional node pool to a Kubernetes clusters, send a POST request
to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools` with the following
attributes.
| +| | `DELETE` | | To delete a node pool, send a DELETE request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.

A 204 status code with no body will be returned in response to a successful
request. Nodes in the pool will subsequently be drained and deleted.
| +| | `EXEC` | | To show information about a specific node pool in a Kubernetes cluster, send
a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID`.
| +| | `EXEC` | | To list all of the node pools in a Kubernetes clusters, send a GET request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools`.
| +| | `EXEC` | | The endpoint has been deprecated. Please use the DELETE
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID`
method instead.
| +| | `EXEC` | | To update the name of a node pool, edit the tags applied to it, or adjust its
number of nodes, send a PUT request to
`/v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID` with the
following attributes.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md index a90bf0b43f..f3b7414658 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/nodes/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenodes
TypeResource
Iddigitalocean.kubernetes.nodes
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `delete_node` | `DELETE` | `cluster_id, node_id, node_pool_id` | +| | `DELETE` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md index 7322736f5d..42eab0688c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/options/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoptions
TypeResource
Iddigitalocean.kubernetes.options
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_options` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md index eaf24dda0a..1e86701614 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/upgrades/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameupgrades
TypeResource
Iddigitalocean.kubernetes.upgrades
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `slug` | `string` | The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision. | -| `supported_features` | `array` | The features available with the version of Kubernetes provided by a given slug. | -| `kubernetes_version` | `string` | The upstream version string for the version of Kubernetes provided by a given slug. | +| | `string` | The upstream version string for the version of Kubernetes provided by a given slug. | +| | `string` | The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision. | +| | `array` | The features available with the version of Kubernetes provided by a given slug. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_availableUpgrades` | `SELECT` | `cluster_id` | -| `_get_availableUpgrades` | `EXEC` | `cluster_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md b/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md index 857a893735..47ad2db106 100644 --- a/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/kubernetes/user/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser
TypeResource
Iddigitalocean.kubernetes.user
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `groups` | `array` | A list of in-cluster groups that the user belongs to. | -| `username` | `string` | The username for the cluster admin user. | +| | `array` | A list of in-cluster groups that the user belongs to. | +| | `string` | The username for the cluster admin user. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_clusterUser` | `SELECT` | `cluster_id` | -| `_get_clusterUser` | `EXEC` | `cluster_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md index 8eb52936f4..7abfdc39a3 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/droplets/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplets
TypeResource
Iddigitalocean.load_balancers.droplets
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `loadBalancers_remove_droplets` | `DELETE` | `lb_id, data__droplet_ids` | To remove a Droplet from a load balancer instance, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `loadBalancers_add_droplets` | `EXEC` | `lb_id, data__droplet_ids` | To assign a Droplet to a load balancer instance, send a POST request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.
Individual Droplets can not be added to a load balancer configured with a
Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity"
response from the API.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove a Droplet from a load balancer instance, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `EXEC` | | To assign a Droplet to a load balancer instance, send a POST request to
`/v2/load_balancers/$LOAD_BALANCER_ID/droplets`. In the body of the request,
there should be a `droplet_ids` attribute containing a list of Droplet IDs.
Individual Droplets can not be added to a load balancer configured with a
Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity"
response from the API.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md index b803431df3..5748391147 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/forwarding_rules/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameforwarding_rules
TypeResource
Iddigitalocean.load_balancers.forwarding_rules
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `loadBalancers_remove_forwardingRules` | `DELETE` | `lb_id, data__forwarding_rules` | To remove forwarding rules from a load balancer instance, send a DELETE
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the
body of the request, there should be a `forwarding_rules` attribute containing
an array of rules to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| -| `loadBalancers_add_forwardingRules` | `EXEC` | `lb_id, data__forwarding_rules` | To add an additional forwarding rule to a load balancer instance, send a POST
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the body
of the request, there should be a `forwarding_rules` attribute containing an
array of rules to be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `DELETE` | | To remove forwarding rules from a load balancer instance, send a DELETE
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the
body of the request, there should be a `forwarding_rules` attribute containing
an array of rules to be removed.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| +| | `EXEC` | | To add an additional forwarding rule to a load balancer instance, send a POST
request to `/v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules`. In the body
of the request, there should be a `forwarding_rules` attribute containing an
array of rules to be added.

No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md index c12647137d..8c560710cf 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Load Balancers :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md b/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md index e90959320c..ded8142b48 100644 --- a/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/load_balancers/load_balancers/index.md @@ -14,48 +14,51 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameload_balancers
TypeResource
Iddigitalocean.load_balancers.load_balancers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference a load balancer. | -| `name` | `string` | A human-readable name for a load balancer instance. | -| `ip` | `string` | An attribute containing the public-facing IP address of the load balancer. | -| `enable_proxy_protocol` | `boolean` | A boolean value indicating whether PROXY Protocol is in use. | -| `redirect_http_to_https` | `boolean` | A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443. | -| `enable_backend_keepalive` | `boolean` | A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. | -| `region` | `object` | The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned. | -| `project_id` | `string` | The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. | -| `health_check` | `object` | An object specifying health check settings for the load balancer. | -| `vpc_uuid` | `string` | A string specifying the UUID of the VPC to which the load balancer is assigned. | -| `size` | `string` | This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.
* `lb-small` = 1 node
* `lb-medium` = 3 nodes
* `lb-large` = 6 nodes

You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation. | -| `sticky_sessions` | `object` | An object specifying sticky sessions settings for the load balancer. | -| `algorithm` | `string` | This field has been deprecated. You can no longer specify an algorithm for load balancers. | -| `size_unit` | `integer` | How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. | -| `http_idle_timeout_seconds` | `integer` | An integer value which configures the idle timeout for HTTP requests to the target droplets. | -| `disable_lets_encrypt_dns_records` | `boolean` | A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. | -| `droplet_ids` | `array` | An array containing the IDs of the Droplets assigned to the load balancer. | -| `tag` | `string` | The name of a Droplet tag corresponding to Droplets assigned to the load balancer. | -| `firewall` | `object` | An object specifying allow and deny rules to control traffic to the load balancer. | -| `status` | `string` | A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`. | -| `forwarding_rules` | `array` | An array of objects specifying the forwarding rules for a load balancer. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the load balancer was created. | +| | `string` | A unique ID that can be used to identify and reference a load balancer. | +| | `string` | A human-readable name for a load balancer instance. | +| | `string` | This field has been deprecated. You can no longer specify an algorithm for load balancers. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the load balancer was created. | +| | `boolean` | A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. | +| | `array` | An array containing the IDs of the Droplets assigned to the load balancer. | +| | `boolean` | A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. | +| | `boolean` | A boolean value indicating whether PROXY Protocol is in use. | +| | `object` | An object specifying allow and deny rules to control traffic to the load balancer. | +| | `array` | An array of objects specifying the forwarding rules for a load balancer. | +| | `object` | An object specifying health check settings for the load balancer. | +| | `integer` | An integer value which configures the idle timeout for HTTP requests to the target droplets. | +| | `string` | An attribute containing the public-facing IP address of the load balancer. | +| | `string` | The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. | +| | `boolean` | A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443. | +| | `object` | The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned. | +| | `string` | This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.
* `lb-small` = 1 node
* `lb-medium` = 3 nodes
* `lb-large` = 6 nodes

You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation. | +| | `integer` | How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. | +| | `string` | A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`. | +| | `object` | An object specifying sticky sessions settings for the load balancer. | +| | `string` | The name of a Droplet tag corresponding to Droplets assigned to the load balancer. | +| | `string` | A string specifying the UUID of the VPC to which the load balancer is assigned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `loadBalancers_get` | `SELECT` | `lb_id` | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| -| `loadBalancers_list` | `SELECT` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| -| `loadBalancers_create` | `INSERT` | | To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.

You can specify the Droplets that will sit behind the load balancer using one
of two methods:

* Set `droplet_ids` to a list of specific Droplet IDs.
* Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.

These methods are mutually exclusive.
| -| `loadBalancers_delete` | `DELETE` | `lb_id` | To delete a load balancer instance, disassociating any Droplets assigned to it
and removing it from your account, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_loadBalancers_get` | `EXEC` | `lb_id` | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| -| `_loadBalancers_list` | `EXEC` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| -| `loadBalancers_update` | `EXEC` | `lb_id` | To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
| +| | `SELECT` | | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| +| | `SELECT` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| +| | `INSERT` | | To create a new load balancer instance, send a POST request to
`/v2/load_balancers`.

You can specify the Droplets that will sit behind the load balancer using one
of two methods:

* Set `droplet_ids` to a list of specific Droplet IDs.
* Set `tag` to the name of a tag. All Droplets with this tag applied will be
assigned to the load balancer. Additional Droplets will be automatically
assigned as they are tagged.

These methods are mutually exclusive.
| +| | `DELETE` | | To delete a load balancer instance, disassociating any Droplets assigned to it
and removing it from your account, send a DELETE request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To show information about a load balancer instance, send a GET request to
`/v2/load_balancers/$LOAD_BALANCER_ID`.
| +| | `EXEC` | | To list all of the load balancer instances on your account, send a GET request
to `/v2/load_balancers`.
| +| | `EXEC` | | To update a load balancer's settings, send a PUT request to
`/v2/load_balancers/$LOAD_BALANCER_ID`. The request should contain a full
representation of the load balancer including existing attributes. It may
contain _one of_ the `droplets_ids` or `tag` attributes as they are mutually
exclusive. **Note that any attribute that is not provided will be reset to its
default value.**
| diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md index 790636c05f..f3b3f07564 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/alerts/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namealerts
TypeResource
Iddigitalocean.monitoring.alerts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `meta` | `object` | Information about the response itself. | -| `policies` | `array` | | -| `links` | `object` | | +| | `object` | | +| | `object` | Information about the response itself. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_alertPolicy` | `SELECT` | `alert_uuid` | To retrieve a given alert policy, send a GET request to `/v2/monitoring/alerts/{alert_uuid}` | -| `list_alertPolicy` | `SELECT` | | Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. | -| `create_alertPolicy` | `INSERT` | `data__alerts, data__compare, data__description, data__enabled, data__entities, data__tags, data__type, data__value, data__window` | To create a new alert, send a POST request to `/v2/monitoring/alerts`. | -| `delete_alertPolicy` | `DELETE` | `alert_uuid` | To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}` | -| `update_alertPolicy` | `EXEC` | `alert_uuid, data__alerts, data__compare, data__description, data__enabled, data__entities, data__tags, data__type, data__value, data__window` | To update en existing policy, send a PUT request to `v2/monitoring/alerts/{alert_uuid}`. | +| | `SELECT` | | To retrieve a given alert policy, send a GET request to `/v2/monitoring/alerts/{alert_uuid}` | +| | `SELECT` | | Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. | +| | `INSERT` | | To create a new alert, send a POST request to `/v2/monitoring/alerts`. | +| | `DELETE` | | To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}` | +| | `EXEC` | | To update en existing policy, send a PUT request to `v2/monitoring/alerts/{alert_uuid}`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md index 73ac1b5572..60fbfec7b9 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_bandwidth/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_bandwidth
TypeResource
Iddigitalocean.monitoring.droplet_bandwidth
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletBandwidthMetrics` | `SELECT` | `direction, end, host_id, interface, start` | -| `_get_dropletBandwidthMetrics` | `EXEC` | `direction, end, host_id, interface, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md index ef7f74f5a5..d3b507e626 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_cpu/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_cpu
TypeResource
Iddigitalocean.monitoring.droplet_cpu
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_DropletCpuMetrics` | `SELECT` | `end, host_id, start` | -| `_get_DropletCpuMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md index 2b6de7720c..6c19125c66 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_free/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_filesystem_free
TypeResource
Iddigitalocean.monitoring.droplet_filesystem_free
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletFilesystemFreeMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletFilesystemFreeMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md index a68ef2b0d6..2b5e6e4b67 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_filesystem_size/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_filesystem_size
TypeResource
Iddigitalocean.monitoring.droplet_filesystem_size
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `values` | `array` | | -| `metric` | `object` | An object containing the metric labels. | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletFilesystemSizeMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletFilesystemSizeMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md index 620cb04597..b4472ba268 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_15_min/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_load_15_min
TypeResource
Iddigitalocean.monitoring.droplet_load_15_min
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletLoad15Metrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletLoad15Metrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md index 62f193147d..e0cf1e05ab 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_1_min/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_load_1_min
TypeResource
Iddigitalocean.monitoring.droplet_load_1_min
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletLoad1Metrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletLoad1Metrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md index 221c40d697..953b1d28f7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_load_5_min/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_load_5_min
TypeResource
Iddigitalocean.monitoring.droplet_load_5_min
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `values` | `array` | | -| `metric` | `object` | An object containing the metric labels. | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletLoad5Metrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletLoad5Metrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md index cb9ef0a100..6da7c357c2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_available/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_memory_available
TypeResource
Iddigitalocean.monitoring.droplet_memory_available
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletMemoryAvailableMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletMemoryAvailableMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md index 40f2a2b5b7..c88b497fd2 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_cached/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_memory_cached
TypeResource
Iddigitalocean.monitoring.droplet_memory_cached
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletMemoryCachedMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletMemoryCachedMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md index 80fda8d009..954b7ef74f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_free/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_memory_free
TypeResource
Iddigitalocean.monitoring.droplet_memory_free
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletMemoryFreeMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletMemoryFreeMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md index 258e78ce9a..cdc64e898b 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/droplet_memory_total/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedroplet_memory_total
TypeResource
Iddigitalocean.monitoring.droplet_memory_total
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metric` | `object` | An object containing the metric labels. | -| `values` | `array` | | +| | `object` | An object containing the metric labels. | +| | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_dropletMemoryTotalMetrics` | `SELECT` | `end, host_id, start` | -| `_get_dropletMemoryTotalMetrics` | `EXEC` | `end, host_id, start` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md b/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md index 53a5238bbc..93aab77126 100644 --- a/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/monitoring/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Monitoring :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md index a581e5f54a..8d8ffd2b19 100644 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + 1 Click Applications :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md index 51d65add11..43003dd5c3 100644 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/kubernetes/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekubernetes
TypeResource
Iddigitalocean.one_click_applications.kubernetes
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `oneClicks_install_kubernetes` | `EXEC` | `data__addon_slugs, data__cluster_uuid` | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md index 1e79afe27f..0d2b15dc98 100644 --- a/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/one_click_applications/one_click_applications/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameone_click_applications
TypeResource
Iddigitalocean.one_click_applications.one_click_applications
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `slug` | `string` | The slug identifier for the 1-Click application. | -| `type` | `string` | The type of the 1-Click application. | +| | `string` | The slug identifier for the 1-Click application. | +| | `string` | The type of the 1-Click application. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `oneClicks_list` | `SELECT` | | -| `_oneClicks_list` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md index c4e4df7544..c7205f76af 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/default/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedefault
TypeResource
Iddigitalocean.projects.default
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique universal identifier of this project. | -| `name` | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | -| `description` | `string` | The description of the project. The maximum length is 255 characters. | -| `updated_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | -| `purpose` | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| -| `environment` | `string` | The environment of the project's resources. | -| `is_default` | `boolean` | If true, all resources will be added to this project if no project is specified. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | -| `owner_id` | `integer` | The integer id of the project owner. | -| `owner_uuid` | `string` | The unique universal identifier of the project owner. | +| | `string` | The unique universal identifier of this project. | +| | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | +| | `string` | The description of the project. The maximum length is 255 characters. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `string` | The environment of the project's resources. | +| | `boolean` | If true, all resources will be added to this project if no project is specified. | +| | `integer` | The integer id of the project owner. | +| | `string` | The unique universal identifier of the project owner. | +| | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_default` | `SELECT` | | To get your default project, send a GET request to `/v2/projects/default`. | -| `_get_default` | `EXEC` | | To get your default project, send a GET request to `/v2/projects/default`. | -| `patch_default` | `EXEC` | | To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. | -| `update_default` | `EXEC` | `data__description, data__environment, data__is_default, data__name, data__purpose` | To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. | +| | `SELECT` | | To get your default project, send a GET request to `/v2/projects/default`. | +| | `EXEC` | | To get your default project, send a GET request to `/v2/projects/default`. | +| | `EXEC` | | To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. | +| | `EXEC` | | To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. | diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md index a26553e40f..dfc1b5a4fa 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/default_resources/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedefault_resources
TypeResource
Iddigitalocean.projects.default_resources
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `status` | `string` | The status of assigning and fetching the resources. | -| `urn` | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | -| `assigned_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | -| `links` | `object` | The links object contains the `self` object, which contains the resource relationship. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `object` | The links object contains the `self` object, which contains the resource relationship. | +| | `string` | The status of assigning and fetching the resources. | +| | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_resources_default` | `SELECT` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | -| `_list_resources_default` | `EXEC` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | -| `assign_resources_default` | `EXEC` | | To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. | +| | `SELECT` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | +| | `EXEC` | | To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. | +| | `EXEC` | | To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/index.md index 3d09d8870e..4d3d63c027 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Projects :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md index 4a4efd9220..1df1b342bc 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/projects/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprojects
TypeResource
Iddigitalocean.projects.projects
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique universal identifier of this project. | -| `name` | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | -| `description` | `string` | The description of the project. The maximum length is 255 characters. | -| `owner_id` | `integer` | The integer id of the project owner. | -| `environment` | `string` | The environment of the project's resources. | -| `purpose` | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| -| `is_default` | `boolean` | If true, all resources will be added to this project if no project is specified. | -| `updated_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | -| `owner_uuid` | `string` | The unique universal identifier of the project owner. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `string` | The unique universal identifier of this project. | +| | `string` | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. | +| | `string` | The description of the project. The maximum length is 255 characters. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `string` | The environment of the project's resources. | +| | `boolean` | If true, all resources will be added to this project if no project is specified. | +| | `integer` | The integer id of the project owner. | +| | `string` | The unique universal identifier of the project owner. | +| | `string` | The purpose of the project. The maximum length is 255 characters. It can
have one of the following values:

- Just trying out DigitalOcean
- Class project / Educational purposes
- Website or blog
- Web Application
- Service or API
- Mobile Application
- Machine learning / AI / Data processing
- IoT
- Operational / Developer tooling

If another value for purpose is specified, for example, "your custom purpose",
your purpose will be stored as `Other: your custom purpose`.
| +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `project_id` | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | -| `list` | `SELECT` | | To list all your projects, send a GET request to `/v2/projects`. | -| `create` | `INSERT` | `data__name, data__purpose` | To create a project, send a POST request to `/v2/projects`. | -| `delete` | `DELETE` | `project_id` | To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To
be deleted, a project must not have any resources assigned to it. Any existing
resources must first be reassigned or destroyed, or you will receive a 412 error.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_get` | `EXEC` | `project_id` | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | -| `_list` | `EXEC` | | To list all your projects, send a GET request to `/v2/projects`. | -| `patch` | `EXEC` | `project_id` | To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. | -| `update` | `EXEC` | `project_id, data__description, data__environment, data__is_default, data__name, data__purpose` | To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. | +| | `SELECT` | | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | +| | `SELECT` | | To list all your projects, send a GET request to `/v2/projects`. | +| | `INSERT` | | To create a project, send a POST request to `/v2/projects`. | +| | `DELETE` | | To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To
be deleted, a project must not have any resources assigned to it. Any existing
resources must first be reassigned or destroyed, or you will receive a 412 error.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. | +| | `EXEC` | | To list all your projects, send a GET request to `/v2/projects`. | +| | `EXEC` | | To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. | +| | `EXEC` | | To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. | diff --git a/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md b/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md index 5fa14fb501..5177760eee 100644 --- a/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/projects/resources/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameresources
TypeResource
Iddigitalocean.projects.resources
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `links` | `object` | The links object contains the `self` object, which contains the resource relationship. | -| `status` | `string` | The status of assigning and fetching the resources. | -| `urn` | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | -| `assigned_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the project was created. | +| | `object` | The links object contains the `self` object, which contains the resource relationship. | +| | `string` | The status of assigning and fetching the resources. | +| | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_resources` | `SELECT` | `project_id` | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | -| `_list_resources` | `EXEC` | `project_id` | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | -| `assign_resources` | `EXEC` | `project_id` | To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. | +| | `SELECT` | | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | +| | `EXEC` | | To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. | +| | `EXEC` | | To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/regions/index.md index 141561bc1c..f48b23f00c 100644 --- a/docs/digitalocean-docs/providers/digitalocean/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/regions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Regions :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md b/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md index 2063aa1ef4..69106b4022 100644 --- a/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/regions/regions/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameregions
TypeResource
Iddigitalocean.regions.regions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The display name of the region. This will be a full name that is used in the control panel and other interfaces. | -| `available` | `boolean` | This is a boolean value that represents whether new Droplets can be created in this region. | -| `features` | `` | This attribute is set to an array which contains features available in this region | -| `sizes` | `` | This attribute is set to an array which contains the identifying slugs for the sizes available in this region. | -| `slug` | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `string` | The display name of the region. This will be a full name that is used in the control panel and other interfaces. | +| | `boolean` | This is a boolean value that represents whether new Droplets can be created in this region. | +| | `` | This attribute is set to an array which contains features available in this region | +| | `` | This attribute is set to an array which contains the identifying slugs for the sizes available in this region. | +| | `string` | A human-readable string that is used as a unique identifier for each region. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | | -| `_list` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md index 9adfd62a4b..acebe80eb0 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/actions/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Iddigitalocean.reserved_ips.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique numeric ID that can be used to identify and reference an action. | -| `region_slug` | `string` | A human-readable string that is used as a unique identifier for each region. | -| `resource_type` | `string` | The type of resource that the action is associated with. | -| `resource_id` | `integer` | A unique identifier for the resource that the action is associated with. | -| `completed_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | -| `type` | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | -| `region` | `object` | | -| `started_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | -| `status` | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `integer` | A unique numeric ID that can be used to identify and reference an action. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was completed. | +| | `object` | | +| | `string` | A human-readable string that is used as a unique identifier for each region. | +| | `integer` | A unique identifier for the resource that the action is associated with. | +| | `string` | The type of resource that the action is associated with. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the action was initiated. | +| | `string` | The current status of the action. This can be "in-progress", "completed", or "errored". | +| | `string` | This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `reservedIPsActions_get` | `SELECT` | `action_id, reserved_ip` | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | -| `reservedIPsActions_list` | `SELECT` | `reserved_ip` | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | -| `reservedIPsActions_post` | `INSERT` | `reserved_ip` | To initiate an action on a reserved IP send a POST request to
`/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a reserved IP to a Droplet
\| `unassign` \| Unassign a reserved IP from a Droplet
| -| `_reservedIPsActions_get` | `EXEC` | `action_id, reserved_ip` | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | -| `_reservedIPsActions_list` | `EXEC` | `reserved_ip` | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | +| | `SELECT` | | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | +| | `SELECT` | | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | +| | `INSERT` | | To initiate an action on a reserved IP send a POST request to
`/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request,
set the `type` attribute to on of the supported action types:

\| Action \| Details
\|------------\|--------
\| `assign` \| Assigns a reserved IP to a Droplet
\| `unassign` \| Unassign a reserved IP from a Droplet
| +| | `EXEC` | | To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. | +| | `EXEC` | | To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md index fe320e6b5c..0043e0a5c1 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Reserved IPs :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md index fa2c3ab928..9965ec8d0a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/reserved_ips/reserved_ips/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namereserved_ips
TypeResource
Iddigitalocean.reserved_ips.reserved_ips
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ip` | `string` | The public IP address of the reserved IP. It also serves as its identifier. | -| `locked` | `boolean` | A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted. | -| `project_id` | `string` | The UUID of the project to which the reserved IP currently belongs. | -| `region` | `object` | The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned. | -| `droplet` | `` | The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. | +| | `` | The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. | +| | `string` | The public IP address of the reserved IP. It also serves as its identifier. | +| | `boolean` | A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted. | +| | `string` | The UUID of the project to which the reserved IP currently belongs. | +| | `object` | The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `reservedIPs_get` | `SELECT` | `reserved_ip` | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | -| `reservedIPs_list` | `SELECT` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | -| `reservedIPs_create` | `INSERT` | | On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to `/v2/reserved_ips` with the `droplet_id` attribute.

* To create a new reserved IP reserved to a region, send a POST request to
`/v2/reserved_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. | -| `reservedIPs_delete` | `DELETE` | `reserved_ip` | To delete a reserved IP and remove it from your account, send a DELETE request
to `/v2/reserved_ips/$RESERVED_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| -| `_reservedIPs_get` | `EXEC` | `reserved_ip` | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | -| `_reservedIPs_list` | `EXEC` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | +| | `SELECT` | | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | +| | `SELECT` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | +| | `INSERT` | | On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to `/v2/reserved_ips` with the `droplet_id` attribute.

* To create a new reserved IP reserved to a region, send a POST request to
`/v2/reserved_ips` with the `region` attribute.

**Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. | +| | `DELETE` | | To delete a reserved IP and remove it from your account, send a DELETE request
to `/v2/reserved_ips/$RESERVED_IP_ADDR`.

A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
| +| | `EXEC` | | To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. | +| | `EXEC` | | To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/sizes/index.md index 2b078685dc..1aa7505b72 100644 --- a/docs/digitalocean-docs/providers/digitalocean/sizes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/sizes/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Sizes :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md b/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md index 52e35aef81..81cf8410c5 100644 --- a/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/sizes/sizes/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesizes
TypeResource
Iddigitalocean.sizes.sizes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `description` | `string` | A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. | -| `regions` | `array` | An array containing the region slugs where this size is available for Droplet creates. | -| `disk` | `integer` | The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes. | -| `transfer` | `number` | The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. | -| `price_monthly` | `number` | This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. | -| `slug` | `string` | A human-readable string that is used to uniquely identify each size. | -| `price_hourly` | `number` | This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. | -| `vcpus` | `integer` | The integer of number CPUs allocated to Droplets of this size. | -| `memory` | `integer` | The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes. | -| `available` | `boolean` | This is a boolean value that represents whether new Droplets can be created with this size. | +| | `string` | A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. | +| | `boolean` | This is a boolean value that represents whether new Droplets can be created with this size. | +| | `integer` | The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes. | +| | `integer` | The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes. | +| | `number` | This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. | +| | `number` | This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. | +| | `array` | An array containing the region slugs where this size is available for Droplet creates. | +| | `string` | A human-readable string that is used to uniquely identify each size. | +| | `number` | The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. | +| | `integer` | The integer of number CPUs allocated to Droplets of this size. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | | -| `_list` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md index 36997b4e92..68a3592d11 100644 --- a/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/snapshots/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Snapshots :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md b/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md index ae26afa18d..27d6800515 100644 --- a/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/snapshots/snapshots/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesnapshots
TypeResource
Iddigitalocean.snapshots.snapshots
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier for the snapshot. | -| `name` | `string` | A human-readable name for the snapshot. | -| `resource_id` | `string` | The unique identifier for the resource that the snapshot originated from. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | -| `resource_type` | `string` | The type of resource that the snapshot originated from. | -| `min_disk_size` | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | -| `size_gigabytes` | `number` | The billable size of the snapshot in gigabytes. | -| `tags` | `array` | An array of Tags the snapshot has been tagged with. | -| `regions` | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | +| | `string` | The unique identifier for the snapshot. | +| | `string` | A human-readable name for the snapshot. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the snapshot was created. | +| | `integer` | The minimum size in GB required for a volume or Droplet to use this snapshot. | +| | `array` | An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values. | +| | `string` | The unique identifier for the resource that the snapshot originated from. | +| | `string` | The type of resource that the snapshot originated from. | +| | `number` | The billable size of the snapshot in gigabytes. | +| | `array` | An array of Tags the snapshot has been tagged with. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `snapshot_id` | To retrieve information about a snapshot, send a GET request to
`/v2/snapshots/$SNAPSHOT_ID`.

The response will be a JSON object with a key called `snapshot`. The value of
this will be an snapshot object containing the standard snapshot attributes.
| -| `list` | `SELECT` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| -| `delete` | `DELETE` | `snapshot_id` | Both Droplet and volume snapshots are managed through the `/v2/snapshots/`
endpoint. To delete a snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| -| `_list` | `EXEC` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| +| | `SELECT` | | To retrieve information about a snapshot, send a GET request to
`/v2/snapshots/$SNAPSHOT_ID`.

The response will be a JSON object with a key called `snapshot`. The value of
this will be an snapshot object containing the standard snapshot attributes.
| +| | `SELECT` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| +| | `DELETE` | | Both Droplet and volume snapshots are managed through the `/v2/snapshots/`
endpoint. To delete a snapshot, send a DELETE request to
`/v2/snapshots/$SNAPSHOT_ID`.

A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| +| | `EXEC` | | To list all of the snapshots available on your account, send a GET request to
`/v2/snapshots`.

The response will be a JSON object with a key called `snapshots`. This will be
set to an array of `snapshot` objects, each of which will contain the standard
snapshot attributes.

### Filtering Results by Resource Type

It's possible to request filtered results by including certain query parameters.

#### List Droplet Snapshots

To retrieve only snapshots based on Droplets, include the `resource_type`
query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`.

#### List Volume Snapshots

To retrieve only snapshots based on volumes, include the `resource_type`
query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md index 537b00fe95..c66bd1cbfd 100644 --- a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/account_keys/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccount_keys
TypeResource
Iddigitalocean.ssh_keys.account_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. | -| `name` | `string` | A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. | -| `public_key` | `string` | The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. | -| `fingerprint` | `string` | A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. | +| | `integer` | A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. | +| | `string` | A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. | +| | `string` | A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. | +| | `string` | The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `sshKeys_get` | `SELECT` | `ssh_key_identifier` | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | -| `sshKeys_list` | `SELECT` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | -| `sshKeys_create` | `INSERT` | `data__name, data__public_key` | To add a new SSH public key to your DigitalOcean account, send a POST request to `/v2/account/keys`. Set the `name` attribute to the name you wish to use and the `public_key` attribute to the full public key you are adding. | -| `sshKeys_delete` | `DELETE` | `ssh_key_identifier` | To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | -| `_sshKeys_get` | `EXEC` | `ssh_key_identifier` | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | -| `_sshKeys_list` | `EXEC` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | -| `sshKeys_update` | `EXEC` | `ssh_key_identifier` | To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or `/v2/account/keys/$SSH_KEY_FINGERPRINT`. Set the `name` attribute to the new name you want to use. | +| | `SELECT` | | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | +| | `SELECT` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | +| | `INSERT` | | To add a new SSH public key to your DigitalOcean account, send a POST request to `/v2/account/keys`. Set the `name` attribute to the name you wish to use and the `public_key` attribute to the full public key you are adding. | +| | `DELETE` | | To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | +| | `EXEC` | | To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`.
The response will be a JSON object with the key `ssh_key` and value an ssh_key object which contains the standard ssh_key attributes. | +| | `EXEC` | | To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. | +| | `EXEC` | | To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or `/v2/account/keys/$SSH_KEY_FINGERPRINT`. Set the `name` attribute to the new name you want to use. | diff --git a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md index 54a31f8fe9..fa8460ef60 100644 --- a/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/ssh_keys/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + SSH Keys :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/index.md index 94a3cbf7ba..1774ae0f2e 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Tags :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md index 793860e703..0f4973bbb7 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/resources/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameresources
TypeResource
Iddigitalocean.tags.resources
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `assign_resources` | `EXEC` | `tag_id, data__resources` | Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | -| `unassign_resources` | `EXEC` | `tag_id, data__resources` | Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | +| | `EXEC` | | Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | +| | `EXEC` | | Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes.
Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. | diff --git a/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md b/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md index cb419e102c..a34afed450 100644 --- a/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/tags/tags/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Iddigitalocean.tags.tags
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.
There is a limit of 255 characters per tag.

**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.

When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).

Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD".
| -| `resources` | `object` | An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. | +| | `string` | The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.
There is a limit of 255 characters per tag.

**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.

When working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named "PROD", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).

Tagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named "PROD", you can tag resources in the control panel by entering "prod". The tag will still display with its canonical capitalization, "PROD".
| +| | `object` | An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `tag_id` | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | -| `list` | `SELECT` | | To list all of your tags, you can send a GET request to `/v2/tags`. | -| `create` | `INSERT` | | To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. | -| `delete` | `DELETE` | `tag_id` | A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag | -| `_get` | `EXEC` | `tag_id` | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | -| `_list` | `EXEC` | | To list all of your tags, you can send a GET request to `/v2/tags`. | +| | `SELECT` | | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | +| | `SELECT` | | To list all of your tags, you can send a GET request to `/v2/tags`. | +| | `INSERT` | | To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. | +| | `DELETE` | | A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag | +| | `EXEC` | | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. | +| | `EXEC` | | To list all of your tags, you can send a GET request to `/v2/tags`. | diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md index 3872c03f5b..4d6a0c5370 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/check_alerts/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecheck_alerts
TypeResource
Iddigitalocean.uptime.check_alerts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference the alert. | -| `name` | `string` | A human-friendly display name. | -| `notifications` | `object` | The notification settings for a trigger alert. | -| `period` | `string` | Period of time the threshold must be exceeded to trigger the alert. | -| `threshold` | `integer` | The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type. | -| `type` | `string` | The type of alert. | -| `comparison` | `string` | The comparison operator used against the alert's threshold. | +| | `string` | A unique ID that can be used to identify and reference the alert. | +| | `string` | A human-friendly display name. | +| | `string` | The comparison operator used against the alert's threshold. | +| | `object` | The notification settings for a trigger alert. | +| | `string` | Period of time the threshold must be exceeded to trigger the alert. | +| | `integer` | The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type. | +| | `string` | The type of alert. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `alert_get` | `SELECT` | `alert_id, check_id` | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | -| `list` | `SELECT` | `check_id` | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | -| `alert_create` | `INSERT` | `check_id, data__name, data__notifications, data__type` | To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes
in the table below in the JSON body.
| -| `alert_delete` | `DELETE` | `alert_id, check_id` | To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status
code with no body will be returned in response to a successful request.
| -| `_alert_get` | `EXEC` | `alert_id, check_id` | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | -| `_list` | `EXEC` | `check_id` | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | -| `alert_update` | `EXEC` | `alert_id, check_id` | To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.
| +| | `SELECT` | | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | +| | `SELECT` | | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | +| | `INSERT` | | To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes
in the table below in the JSON body.
| +| | `DELETE` | | To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status
code with no body will be returned in response to a successful request.
| +| | `EXEC` | | To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. | +| | `EXEC` | | To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. | +| | `EXEC` | | To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md index ebb94deef4..eba709c03f 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/check_state/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecheck_state
TypeResource
Iddigitalocean.uptime.check_state
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `previous_outage` | `object` | | -| `regions` | `object` | A map of region to regional state | +| | `object` | | +| | `object` | A map of region to regional state | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `check_id` | -| `_get` | `EXEC` | `check_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md index e065991131..197a387751 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/checks/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namechecks
TypeResource
Iddigitalocean.uptime.checks
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference the check. | -| `name` | `string` | A human-friendly display name. | -| `type` | `string` | The type of health check to perform. | -| `enabled` | `boolean` | A boolean value indicating whether the check is enabled/disabled. | -| `regions` | `array` | An array containing the selected regions to perform healthchecks from. | -| `target` | `string` | The endpoint to perform healthchecks on. | +| | `string` | A unique ID that can be used to identify and reference the check. | +| | `string` | A human-friendly display name. | +| | `boolean` | A boolean value indicating whether the check is enabled/disabled. | +| | `array` | An array containing the selected regions to perform healthchecks from. | +| | `string` | The endpoint to perform healthchecks on. | +| | `string` | The type of health check to perform. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `check_get` | `SELECT` | `check_id` | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | -| `list` | `SELECT` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | -| `check_create` | `INSERT` | `data__enabled, data__name, data__regions, data__target, data__type` | To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes
in the table below in the JSON body.
| -| `check_delete` | `DELETE` | `check_id` | To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status
code with no body will be returned in response to a successful request.


Deleting a check will also delete alerts associated with the check.
| -| `_check_get` | `EXEC` | `check_id` | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | -| `_list` | `EXEC` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | -| `check_update` | `EXEC` | `check_id` | To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`.
| +| | `SELECT` | | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | +| | `SELECT` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | +| | `INSERT` | | To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes
in the table below in the JSON body.
| +| | `DELETE` | | To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status
code with no body will be returned in response to a successful request.


Deleting a check will also delete alerts associated with the check.
| +| | `EXEC` | | To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. | +| | `EXEC` | | To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. | +| | `EXEC` | | To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`.
| diff --git a/docs/digitalocean-docs/providers/digitalocean/uptime/index.md b/docs/digitalocean-docs/providers/digitalocean/uptime/index.md index c664a78cf7..ac24ff38aa 100644 --- a/docs/digitalocean-docs/providers/digitalocean/uptime/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/uptime/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + Uptime :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md index 80d9770611..29ace23046 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- + VPCs :::info Service Summary diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md index aa38c83b5c..b0eb9b824a 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/members/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemembers
TypeResource
Iddigitalocean.vpcs.members
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the resource. | -| `urn` | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format that represents when the resource was created. | +| | `string` | The name of the resource. | +| | `string` | A time value given in ISO8601 combined date and time format that represents when the resource was created. | +| | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_members` | `SELECT` | `vpc_id` | -| `_list_members` | `EXEC` | `vpc_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md b/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md index 88bdaddd51..2c5349be18 100644 --- a/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md +++ b/docs/digitalocean-docs/providers/digitalocean/vpcs/vpcs/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/digitalocean/stackql-digitalocean-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevpcs
TypeResource
Iddigitalocean.vpcs.vpcs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique ID that can be used to identify and reference the VPC. | -| `name` | `string` | The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. | -| `description` | `string` | A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters. | -| `region` | `string` | The slug identifier for the region where the VPC will be created. | -| `default` | `boolean` | A boolean value indicating whether or not the VPC is the default network for the region. All applicable resources are placed into the default VPC network unless otherwise specified during their creation. The `default` field cannot be unset from `true`. If you want to set a new default VPC network, update the `default` field of another VPC network in the same region. The previous network's `default` field will be set to `false` when a new default VPC has been defined. | -| `created_at` | `string` | A time value given in ISO8601 combined date and time format. | -| `urn` | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | -| `ip_range` | `string` | The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than `/28` nor larger than `/16`. If no IP range is specified, a `/20` network range is generated that won't conflict with other VPC networks in your account. | +| | `string` | A unique ID that can be used to identify and reference the VPC. | +| | `string` | The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. | +| | `string` | A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters. | +| | `string` | A time value given in ISO8601 combined date and time format. | +| | `boolean` | A boolean value indicating whether or not the VPC is the default network for the region. All applicable resources are placed into the default VPC network unless otherwise specified during their creation. The `default` field cannot be unset from `true`. If you want to set a new default VPC network, update the `default` field of another VPC network in the same region. The previous network's `default` field will be set to `false` when a new default VPC has been defined. | +| | `string` | The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than `/28` nor larger than `/16`. If no IP range is specified, a `/20` network range is generated that won't conflict with other VPC networks in your account. | +| | `string` | The slug identifier for the region where the VPC will be created. | +| | `string` | The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `vpc_id` | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | -| `list` | `SELECT` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | -| `create` | `INSERT` | `data__name, data__region` | To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes
in the table below in the JSON body.

**Note:** If you do not currently have a VPC network in a specific datacenter
region, the first one that you create will be set as the default for that
region. The default VPC for a region cannot be changed or deleted.
| -| `delete` | `DELETE` | `vpc_id` | To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status
code with no body will be returned in response to a successful request.

The default VPC for a region can not be deleted. Additionally, a VPC can only
be deleted if it does not contain any member resources. Attempting to delete
a region's default VPC or a VPC that still has members will result in a
403 Forbidden error response.
| -| `_get` | `EXEC` | `vpc_id` | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | -| `_list` | `EXEC` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | -| `patch` | `EXEC` | `vpc_id` | To update a subset of information about a VPC, send a PATCH request to
`/v2/vpcs/$VPC_ID`.
| -| `update` | `EXEC` | `vpc_id, data__name` | To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`.
| +| | `SELECT` | | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | +| | `SELECT` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | +| | `INSERT` | | To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes
in the table below in the JSON body.

**Note:** If you do not currently have a VPC network in a specific datacenter
region, the first one that you create will be set as the default for that
region. The default VPC for a region cannot be changed or deleted.
| +| | `DELETE` | | To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status
code with no body will be returned in response to a successful request.

The default VPC for a region can not be deleted. Additionally, a VPC can only
be deleted if it does not contain any member resources. Attempting to delete
a region's default VPC or a VPC that still has members will result in a
403 Forbidden error response.
| +| | `EXEC` | | To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. | +| | `EXEC` | | To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. | +| | `EXEC` | | To update a subset of information about a VPC, send a PATCH request to
`/v2/vpcs/$VPC_ID`.
| +| | `EXEC` | | To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`.
| diff --git a/docs/linode-docs/index.md b/docs/linode-docs/index.md index fc4b07703b..1b226cb6ed 100644 --- a/docs/linode-docs/index.md +++ b/docs/linode-docs/index.md @@ -13,9 +13,11 @@ custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png id: linode-doc slug: /providers/linode - --- - Cloud Computing Services by Akamai. + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Cloud Computing Services by Akamai. :::info Provider Summary (v23.05.00149) @@ -49,7 +51,7 @@ REGISTRY PULL linode; The following system environment variables are used for authentication by default: -- `LINODE_TOKEN` - Linode API token (see [How to Create a Linode API Token](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/#create-an-api-token)) +- - Linode API token (see [How to Create a Linode API Token](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/#create-an-api-token)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -98,4 +100,4 @@ stackql.exe shell --auth=$Auth view
volumes
- \ No newline at end of file + diff --git a/docs/linode-docs/providers/linode/account/account/index.md b/docs/linode-docs/providers/linode/account/account/index.md index 0aa22e51c9..a7e1193b76 100644 --- a/docs/linode-docs/providers/linode/account/account/index.md +++ b/docs/linode-docs/providers/linode/account/account/index.md @@ -14,43 +14,46 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccount
TypeResource
Idlinode.account.account
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `zip` | `string` | The zip code of this Account's billing address. The following restrictions apply:

- May only consist of letters, numbers, spaces, and hyphens.
- Must not contain more than 9 letter or number characters.
| -| `capabilities` | `array` | A list of capabilities your account supports.
| -| `company` | `string` | The company name associated with this Account. | -| `tax_id` | `string` | The tax identification number associated with this Account, for tax calculations in some countries. If you do not live in a country that collects tax, this should be an empty string (`""`).
| -| `country` | `string` | The two-letter ISO 3166 country code of this Account's billing address.
| -| `credit_card` | `object` | Credit Card information associated with this Account. | -| `email` | `string` | The email address of the person associated with this Account. | -| `last_name` | `string` | The last name of the person associated with this Account. | -| `balance_uninvoiced` | `number` | This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
| -| `address_1` | `string` | First line of this Account's billing address. | -| `address_2` | `string` | Second line of this Account's billing address. | -| `city` | `string` | The city for this Account's billing address. | -| `active_since` | `string` | The datetime of when the account was activated. | -| `billing_source` | `string` | The source of service charges for this Account, as determined by its relationship with Akamai.
Accounts that are associated with Akamai-specific customers return a value of `akamai`.
All other Accounts return a value of `linode`.
| -| `active_promotions` | `array` | | -| `balance` | `number` | This Account's balance, in US dollars. | -| `state` | `string` | If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. If entering a US military address, state abbreviations (AA, AE, AP) should be entered. If the address is outside the US or CA, this is the Province associated with the Account's billing address.
| -| `phone` | `string` | The phone number associated with this Account. | -| `first_name` | `string` | The first name of the person associated with this Account. | -| `euuid` | `string` | An external unique identifier for this account.
| +| | `array` | | +| | `string` | The datetime of when the account was activated. | +| | `string` | First line of this Account's billing address. | +| | `string` | Second line of this Account's billing address. | +| | `number` | This Account's balance, in US dollars. | +| | `number` | This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
| +| | `string` | The source of service charges for this Account, as determined by its relationship with Akamai.
Accounts that are associated with Akamai-specific customers return a value of `akamai`.
All other Accounts return a value of `linode`.
| +| | `array` | A list of capabilities your account supports.
| +| | `string` | The city for this Account's billing address. | +| | `string` | The company name associated with this Account. | +| | `string` | The two-letter ISO 3166 country code of this Account's billing address.
| +| | `object` | Credit Card information associated with this Account. | +| | `string` | The email address of the person associated with this Account. | +| | `string` | An external unique identifier for this account.
| +| | `string` | The first name of the person associated with this Account. | +| | `string` | The last name of the person associated with this Account. | +| | `string` | The phone number associated with this Account. | +| | `string` | If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. If entering a US military address, state abbreviations (AA, AE, AP) should be entered. If the address is outside the US or CA, this is the Province associated with the Account's billing address.
| +| | `string` | The tax identification number associated with this Account, for tax calculations in some countries. If you do not live in a country that collects tax, this should be an empty string (`""`).
| +| | `string` | The zip code of this Account's billing address. The following restrictions apply:

- May only consist of letters, numbers, spaces, and hyphens.
- Must not contain more than 9 letter or number characters.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAccount` | `SELECT` | | Returns the contact and billing information related to your Account.
| -| `_getAccount` | `EXEC` | | Returns the contact and billing information related to your Account.
| -| `cancelAccount` | `EXEC` | | Cancels an active Linode account. This action will cause Linode to attempt to charge the credit card on file for the remaining balance. An error will occur if Linode fails to charge the credit card on file. Restricted users will not be able to cancel an account.
| -| `updateAccount` | `EXEC` | | Updates contact and billing information related to your Account.
| +| | `SELECT` | | Returns the contact and billing information related to your Account.
| +| | `EXEC` | | Returns the contact and billing information related to your Account.
| +| | `EXEC` | | Cancels an active Linode account. This action will cause Linode to attempt to charge the credit card on file for the remaining balance. An error will occur if Linode fails to charge the credit card on file. Restricted users will not be able to cancel an account.
| +| | `EXEC` | | Updates contact and billing information related to your Account.
| diff --git a/docs/linode-docs/providers/linode/account/credit_card/index.md b/docs/linode-docs/providers/linode/account/credit_card/index.md index 1786a8c2a8..cffd1391fd 100644 --- a/docs/linode-docs/providers/linode/account/credit_card/index.md +++ b/docs/linode-docs/providers/linode/account/credit_card/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecredit_card
TypeResource
Idlinode.account.credit_card
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createCreditCard` | `INSERT` | `data__card_number, data__cvv, data__expiry_month, data__expiry_year` | +| | `INSERT` | | diff --git a/docs/linode-docs/providers/linode/account/entity_transfers/index.md b/docs/linode-docs/providers/linode/account/entity_transfers/index.md index 04691f2acf..ff5d55ddcb 100644 --- a/docs/linode-docs/providers/linode/account/entity_transfers/index.md +++ b/docs/linode-docs/providers/linode/account/entity_transfers/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameentity_transfers
TypeResource
Idlinode.account.entity_transfers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `expiry` | `string` | When this transfer expires. Transfers will automatically expire 24 hours after creation.
| -| `is_sender` | `boolean` | If the requesting account created this transfer.
| -| `status` | `string` | The status of the transfer request.

`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.

`cancelled`: The transfer has been cancelled by the sender.

`completed`: The transfer has completed successfully.

`failed`: The transfer has failed after initiation.

`pending`: The transfer is ready to be accepted.

`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or cancelled.
| -| `token` | `string` | The token used to identify and accept or cancel this transfer.
| -| `updated` | `string` | When this transfer was last updated.
| -| `created` | `string` | When this transfer was created.
| -| `entities` | `object` | A collection of the entities to include in this transfer request, separated by type.
| +| | `string` | When this transfer was created.
| +| | `object` | A collection of the entities to include in this transfer request, separated by type.
| +| | `string` | When this transfer expires. Transfers will automatically expire 24 hours after creation.
| +| | `boolean` | If the requesting account created this transfer.
| +| | `string` | The status of the transfer request.

`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.

`cancelled`: The transfer has been cancelled by the sender.

`completed`: The transfer has completed successfully.

`failed`: The transfer has failed after initiation.

`pending`: The transfer is ready to be accepted.

`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or cancelled.
| +| | `string` | The token used to identify and accept or cancel this transfer.
| +| | `string` | When this transfer was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getEntityTransfer` | `SELECT` | `token` | **DEPRECATED**. Please use [Service Transfer View](/docs/api/account/#service-transfer-view).
| -| `getEntityTransfers` | `SELECT` | | **DEPRECATED**. Please use [Service Transfers List](/docs/api/account/#service-transfers-list).
| -| `createEntityTransfer` | `INSERT` | `data__entities` | **DEPRECATED**. Please use [Service Transfer Create](/docs/api/account/#service-transfer-create).
| -| `deleteEntityTransfer` | `DELETE` | `token` | **DEPRECATED**. Please use [Service Transfer Cancel](/docs/api/account/#service-transfer-cancel).
| -| `_getEntityTransfer` | `EXEC` | `token` | **DEPRECATED**. Please use [Service Transfer View](/docs/api/account/#service-transfer-view).
| -| `_getEntityTransfers` | `EXEC` | | **DEPRECATED**. Please use [Service Transfers List](/docs/api/account/#service-transfers-list).
| -| `acceptEntityTransfer` | `EXEC` | `token` | **DEPRECATED**. Please use [Service Transfer Accept](/docs/api/account/#service-transfer-accept).
| +| | `SELECT` | | **DEPRECATED**. Please use [Service Transfer View](/docs/api/account/#service-transfer-view).
| +| | `SELECT` | | **DEPRECATED**. Please use [Service Transfers List](/docs/api/account/#service-transfers-list).
| +| | `INSERT` | | **DEPRECATED**. Please use [Service Transfer Create](/docs/api/account/#service-transfer-create).
| +| | `DELETE` | | **DEPRECATED**. Please use [Service Transfer Cancel](/docs/api/account/#service-transfer-cancel).
| +| | `EXEC` | | **DEPRECATED**. Please use [Service Transfer View](/docs/api/account/#service-transfer-view).
| +| | `EXEC` | | **DEPRECATED**. Please use [Service Transfers List](/docs/api/account/#service-transfers-list).
| +| | `EXEC` | | **DEPRECATED**. Please use [Service Transfer Accept](/docs/api/account/#service-transfer-accept).
| diff --git a/docs/linode-docs/providers/linode/account/events/index.md b/docs/linode-docs/providers/linode/account/events/index.md index d7f983a364..7cab3a8a46 100644 --- a/docs/linode-docs/providers/linode/account/events/index.md +++ b/docs/linode-docs/providers/linode/account/events/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevents
TypeResource
Idlinode.account.events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this Event. | -| `status` | `string` | The current status of this Event. | -| `percent_complete` | `integer` | A percentage estimating the amount of time remaining for an Event.
Returns `null` for notification events.
| -| `read` | `boolean` | If this Event has been read. | -| `username` | `string` | The username of the User who caused the Event.
| -| `entity` | `object` | Detailed information about the Event's entity, including ID, type, label, and URL used to access it.
| -| `duration` | `number` | The total duration in seconds that it takes for the Event to complete.
| -| `seen` | `boolean` | If this Event has been seen. | -| `action` | `string` | The action that caused this Event. New actions may be added in the future.
| -| `rate` | `string` | The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
| -| `time_remaining` | `string` | The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done.
| -| `message` | `string` | Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.
| -| `created` | `string` | When this Event was created. | -| `secondary_entity` | `object` | Detailed information about the Event's secondary entity, which provides additional information
for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.
| +| | `integer` | The unique ID of this Event. | +| | `string` | The action that caused this Event. New actions may be added in the future.
| +| | `string` | When this Event was created. | +| | `number` | The total duration in seconds that it takes for the Event to complete.
| +| | `object` | Detailed information about the Event's entity, including ID, type, label, and URL used to access it.
| +| | `string` | Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.
| +| | `integer` | A percentage estimating the amount of time remaining for an Event.
Returns `null` for notification events.
| +| | `string` | The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
| +| | `boolean` | If this Event has been read. | +| | `object` | Detailed information about the Event's secondary entity, which provides additional information
for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.
| +| | `boolean` | If this Event has been seen. | +| | `string` | The current status of this Event. | +| | `string` | The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done.
| +| | `string` | The username of the User who caused the Event.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getEvent` | `SELECT` | `eventId` | Returns a single Event object.
| -| `getEvents` | `SELECT` | | Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
| -| `_getEvent` | `EXEC` | `eventId` | Returns a single Event object.
| -| `_getEvents` | `EXEC` | | Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
| -| `eventRead` | `EXEC` | `eventId` | Marks a single Event as read. | -| `eventSeen` | `EXEC` | `eventId` | Marks all Events up to and including this Event by ID as seen.
| +| | `SELECT` | | Returns a single Event object.
| +| | `SELECT` | | Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
| +| | `EXEC` | | Returns a single Event object.
| +| | `EXEC` | | Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
| +| | `EXEC` | | Marks a single Event as read. | +| | `EXEC` | | Marks all Events up to and including this Event by ID as seen.
| diff --git a/docs/linode-docs/providers/linode/account/index.md b/docs/linode-docs/providers/linode/account/index.md index 0aaa7f68dd..d83518a1e4 100644 --- a/docs/linode-docs/providers/linode/account/index.md +++ b/docs/linode-docs/providers/linode/account/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Account :::info Service Summary diff --git a/docs/linode-docs/providers/linode/account/invoices/index.md b/docs/linode-docs/providers/linode/account/invoices/index.md index ac3de84d0d..e304497ce3 100644 --- a/docs/linode-docs/providers/linode/account/invoices/index.md +++ b/docs/linode-docs/providers/linode/account/invoices/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvoices
TypeResource
Idlinode.account.invoices
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The Invoice's unique ID. | -| `subtotal` | `number` | The amount of the Invoice before taxes in US Dollars. | -| `tax` | `number` | The amount of tax levied on the Invoice in US Dollars. | -| `tax_summary` | `array` | The amount of tax broken down into subtotals by source. | -| `total` | `number` | The amount of the Invoice after taxes in US Dollars. | -| `date` | `string` | When this Invoice was generated. | -| `label` | `string` | The Invoice's display label. | +| | `integer` | The Invoice's unique ID. | +| | `string` | When this Invoice was generated. | +| | `string` | The Invoice's display label. | +| | `number` | The amount of the Invoice before taxes in US Dollars. | +| | `number` | The amount of tax levied on the Invoice in US Dollars. | +| | `array` | The amount of tax broken down into subtotals by source. | +| | `number` | The amount of the Invoice after taxes in US Dollars. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getInvoice` | `SELECT` | `invoiceId` | Returns a single Invoice object. | -| `getInvoices` | `SELECT` | | Returns a paginated list of Invoices against your Account.
| -| `_getInvoice` | `EXEC` | `invoiceId` | Returns a single Invoice object. | -| `_getInvoices` | `EXEC` | | Returns a paginated list of Invoices against your Account.
| +| | `SELECT` | | Returns a single Invoice object. | +| | `SELECT` | | Returns a paginated list of Invoices against your Account.
| +| | `EXEC` | | Returns a single Invoice object. | +| | `EXEC` | | Returns a paginated list of Invoices against your Account.
| diff --git a/docs/linode-docs/providers/linode/account/invoices_items/index.md b/docs/linode-docs/providers/linode/account/invoices_items/index.md index a2ea0c1c73..55baafede2 100644 --- a/docs/linode-docs/providers/linode/account/invoices_items/index.md +++ b/docs/linode-docs/providers/linode/account/invoices_items/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvoices_items
TypeResource
Idlinode.account.invoices_items
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `type` | `string` | The type of service, ether `hourly` or `misc`. | -| `quantity` | `integer` | The quantity of this Item for the specified Invoice. | -| `total` | `number` | The price of this Item after taxes in US Dollars. | -| `to` | `string` | The date the Invoice Item ended, based on month. | -| `from` | `string` | The date the Invoice Item started, based on month. | -| `label` | `string` | The Invoice Item's display label. | -| `unit_price` | `string` | The monthly service fee in US Dollars for this Item. | -| `amount` | `number` | The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. | -| `tax` | `number` | The amount of tax levied on this Item in US Dollars. | +| | `number` | The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. | +| | `string` | The date the Invoice Item started, based on month. | +| | `string` | The Invoice Item's display label. | +| | `integer` | The quantity of this Item for the specified Invoice. | +| | `number` | The amount of tax levied on this Item in US Dollars. | +| | `string` | The date the Invoice Item ended, based on month. | +| | `number` | The price of this Item after taxes in US Dollars. | +| | `string` | The type of service, ether `hourly` or `misc`. | +| | `string` | The monthly service fee in US Dollars for this Item. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getInvoiceItems` | `SELECT` | `invoiceId` | -| `_getInvoiceItems` | `EXEC` | `invoiceId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/account/logins/index.md b/docs/linode-docs/providers/linode/account/logins/index.md index 008898f81e..9c517f089b 100644 --- a/docs/linode-docs/providers/linode/account/logins/index.md +++ b/docs/linode-docs/providers/linode/account/logins/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelogins
TypeResource
Idlinode.account.logins
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this login object.
| -| `ip` | `string` | The remote IP address that requested the login.
| -| `restricted` | `boolean` | True if the User that attempted the login was a restricted User, false otherwise.
| -| `status` | `string` | Whether the login attempt succeeded or failed.
| -| `username` | `string` | The username of the User that attempted the login.
| -| `datetime` | `string` | When the login was initiated.
| +| | `integer` | The unique ID of this login object.
| +| | `string` | When the login was initiated.
| +| | `string` | The remote IP address that requested the login.
| +| | `boolean` | True if the User that attempted the login was a restricted User, false otherwise.
| +| | `string` | Whether the login attempt succeeded or failed.
| +| | `string` | The username of the User that attempted the login.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAccountLogin` | `SELECT` | `loginId` | Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.
| -| `getAccountLogins` | `SELECT` | | Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account.
| -| `_getAccountLogin` | `EXEC` | `loginId` | Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.
| -| `_getAccountLogins` | `EXEC` | | Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.
| +| | `SELECT` | | Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.
| +| | `EXEC` | | Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/account/maintenance/index.md b/docs/linode-docs/providers/linode/account/maintenance/index.md index 279fb95cef..069a49ae29 100644 --- a/docs/linode-docs/providers/linode/account/maintenance/index.md +++ b/docs/linode-docs/providers/linode/account/maintenance/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemaintenance
TypeResource
Idlinode.account.maintenance
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `reason` | `string` | The reason maintenance is being performed.
| -| `status` | `string` | The maintenance status.

Maintenance progresses in the following sequence: pending, started, then completed.
| -| `type` | `string` | The type of maintenance.
| -| `when` | `string` | When the maintenance will begin.

[Filterable](/docs/api/#filtering-and-sorting) with the following parameters:

* A single value in date-time string format ("%Y-%m-%dT%H:%M:%S"), which returns only matches to that value.

* A dictionary containing pairs of inequality operator string keys ("+or", "+gt", "+gte", "+lt", "+lte",
or "+neq") and single date-time string format values ("%Y-%m-%dT%H:%M:%S"). "+or" accepts an array of values that
may consist of single date-time strings or dictionaries of inequality operator pairs.
| -| `entity` | `object` | The entity being affected by maintenance.
| +| | `object` | The entity being affected by maintenance.
| +| | `string` | The reason maintenance is being performed.
| +| | `string` | The maintenance status.

Maintenance progresses in the following sequence: pending, started, then completed.
| +| | `string` | The type of maintenance.
| +| | `string` | When the maintenance will begin.

[Filterable](/docs/api/#filtering-and-sorting) with the following parameters:

* A single value in date-time string format ("%Y-%m-%dT%H:%M:%S"), which returns only matches to that value.

* A dictionary containing pairs of inequality operator string keys ("+or", "+gt", "+gte", "+lt", "+lte",
or "+neq") and single date-time string format values ("%Y-%m-%dT%H:%M:%S"). "+or" accepts an array of values that
may consist of single date-time strings or dictionaries of inequality operator pairs.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getMaintenance` | `SELECT` | | -| `_getMaintenance` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/account/notifications/index.md b/docs/linode-docs/providers/linode/account/notifications/index.md index fc1580c9ab..2d16e55502 100644 --- a/docs/linode-docs/providers/linode/account/notifications/index.md +++ b/docs/linode-docs/providers/linode/account/notifications/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotifications
TypeResource
Idlinode.account.notifications
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `type` | `string` | The type of Notification this is. | -| `until` | `string` | If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, `until` would be set to the end of the maintenance window.
| -| `when` | `string` | If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.
| -| `body` | `string` | A full description of this Notification, in markdown format. Not all Notifications include bodies.
| -| `entity` | `object` | Detailed information about the Notification. | -| `label` | `string` | A short description of this Notification.
| -| `message` | `string` | A human-readable description of the Notification. | -| `severity` | `string` | The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.
| +| | `string` | A full description of this Notification, in markdown format. Not all Notifications include bodies.
| +| | `object` | Detailed information about the Notification. | +| | `string` | A short description of this Notification.
| +| | `string` | A human-readable description of the Notification. | +| | `string` | The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.
| +| | `string` | The type of Notification this is. | +| | `string` | If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, `until` would be set to the end of the maintenance window.
| +| | `string` | If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getNotifications` | `SELECT` | | -| `_getNotifications` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/account/oauth_clients/index.md b/docs/linode-docs/providers/linode/account/oauth_clients/index.md index 3705c82a14..76c2e8e925 100644 --- a/docs/linode-docs/providers/linode/account/oauth_clients/index.md +++ b/docs/linode-docs/providers/linode/account/oauth_clients/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoauth_clients
TypeResource
Idlinode.account.oauth_clients
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
| -| `secret` | `string` | The OAuth Client secret, used in the OAuth exchange. This is returned as `<REDACTED>` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
| -| `status` | `string` | The status of this application. `active` by default.
| -| `thumbnail_url` | `string` | The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.
| -| `label` | `string` | The name of this application. This will be presented to users when they are asked to grant it access to their Account.
| -| `public` | `boolean` | If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the <a target="_top" href="https://oauth.net/2/">OAuth spec</a> for more details.
| -| `redirect_uri` | `string` | The location a successful log in from <a target="_top" href="https://login.linode.com">https://login.linode.com</a> should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
| +| | `string` | The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
| +| | `string` | The name of this application. This will be presented to users when they are asked to grant it access to their Account.
| +| | `boolean` | If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the <a target="_top" href="https://oauth.net/2/">OAuth spec</a> for more details.
| +| | `string` | The location a successful log in from <a target="_top" href="https://login.linode.com">https://login.linode.com</a> should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
| +| | `string` | The OAuth Client secret, used in the OAuth exchange. This is returned as `<REDACTED>` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
| +| | `string` | The status of this application. `active` by default.
| +| | `string` | The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getClient` | `SELECT` | `clientId` | Returns information about a single OAuth client.
| -| `getClients` | `SELECT` | | Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.
| -| `createClient` | `INSERT` | `data__label, data__redirect_uri` | Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.
| -| `deleteClient` | `DELETE` | `clientId` | Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by <a target="_top" href="https://login.linode.com">https://login.linode.com</a>, and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work).
| -| `_getClient` | `EXEC` | `clientId` | Returns information about a single OAuth client.
| -| `_getClientThumbnail` | `EXEC` | `clientId` | Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.
| -| `_getClients` | `EXEC` | | Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.
| -| `getClientThumbnail` | `EXEC` | `clientId` | Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.
| -| `resetClientSecret` | `EXEC` | `clientId` | Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail.
| -| `setClientThumbnail` | `EXEC` | `clientId` | Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be publicly-viewable.
| -| `updateClient` | `EXEC` | `clientId` | Update information about an OAuth Client on your Account. This can be especially useful to update the `redirect_uri` of your client in the event that the callback url changed in your application.
| +| | `SELECT` | | Returns information about a single OAuth client.
| +| | `SELECT` | | Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.
| +| | `INSERT` | | Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.
| +| | `DELETE` | | Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by <a target="_top" href="https://login.linode.com">https://login.linode.com</a>, and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work).
| +| | `EXEC` | | Returns information about a single OAuth client.
| +| | `EXEC` | | Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.
| +| | `EXEC` | | Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.
| +| | `EXEC` | | Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.
| +| | `EXEC` | | Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail.
| +| | `EXEC` | | Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be publicly-viewable.
| +| | `EXEC` | | Update information about an OAuth Client on your Account. This can be especially useful to update the `redirect_uri` of your client in the event that the callback url changed in your application.
| diff --git a/docs/linode-docs/providers/linode/account/payment_methods/index.md b/docs/linode-docs/providers/linode/account/payment_methods/index.md index 9e3f491034..78043a6fc1 100644 --- a/docs/linode-docs/providers/linode/account/payment_methods/index.md +++ b/docs/linode-docs/providers/linode/account/payment_methods/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepayment_methods
TypeResource
Idlinode.account.payment_methods
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this Payment Method. | -| `is_default` | `boolean` | Whether this Payment Method is the default method for automatically processing service charges.
| -| `type` | `string` | The type of Payment Method. | -| `created` | `string` | When the Payment Method was added to the Account. | -| `data` | `` | | +| | `integer` | The unique ID of this Payment Method. | +| | `string` | When the Payment Method was added to the Account. | +| | `` | | +| | `boolean` | Whether this Payment Method is the default method for automatically processing service charges.
| +| | `string` | The type of Payment Method. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPaymentMethod` | `SELECT` | `paymentMethodId` | View the details of the specified Payment Method.
| -| `getPaymentMethods` | `SELECT` | | Returns a paginated list of Payment Methods for this Account.
| -| `createPaymentMethod` | `INSERT` | `data__data, data__is_default, data__type` | Adds a Payment Method to your Account with the option to set it as the default method.

* Adding a default Payment Method removes the default status from any other Payment Method.

* An Account can have up to 6 active Payment Methods.

* Up to 60 Payment Methods can be added each day.

* Prior to adding a Payment Method, ensure that your billing address information is up-to-date
with a valid `zip` by using the Account Update ([PUT /account](/docs/api/account/#account-update)) endpoint.

* A `payment_method_add` event is generated when a payment is successfully submitted.
| -| `deletePaymentMethod` | `DELETE` | `paymentMethodId` | Deactivate the specified Payment Method.

The default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method
Add ([POST /account/payment-methods](/docs/api/account/#payment-method-add)) endpoint. To designate an existing
Payment Method as the default method, access the Payment Method Make Default
([POST /account/payment-methods/{paymentMethodId}/make-default](/docs/api/account/#payment-method-make-default))
endpoint.
| -| `_getPaymentMethod` | `EXEC` | `paymentMethodId` | View the details of the specified Payment Method.
| -| `_getPaymentMethods` | `EXEC` | | Returns a paginated list of Payment Methods for this Account.
| -| `makePaymentMethodDefault` | `EXEC` | `paymentMethodId` | Make the specified Payment Method the default method for automatically processing payments.

Removes the default status from any other Payment Method.
| +| | `SELECT` | | View the details of the specified Payment Method.
| +| | `SELECT` | | Returns a paginated list of Payment Methods for this Account.
| +| | `INSERT` | | Adds a Payment Method to your Account with the option to set it as the default method.

* Adding a default Payment Method removes the default status from any other Payment Method.

* An Account can have up to 6 active Payment Methods.

* Up to 60 Payment Methods can be added each day.

* Prior to adding a Payment Method, ensure that your billing address information is up-to-date
with a valid `zip` by using the Account Update ([PUT /account](/docs/api/account/#account-update)) endpoint.

* A `payment_method_add` event is generated when a payment is successfully submitted.
| +| | `DELETE` | | Deactivate the specified Payment Method.

The default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method
Add ([POST /account/payment-methods](/docs/api/account/#payment-method-add)) endpoint. To designate an existing
Payment Method as the default method, access the Payment Method Make Default
([POST /account/payment-methods/{paymentMethodId}/make-default](/docs/api/account/#payment-method-make-default))
endpoint.
| +| | `EXEC` | | View the details of the specified Payment Method.
| +| | `EXEC` | | Returns a paginated list of Payment Methods for this Account.
| +| | `EXEC` | | Make the specified Payment Method the default method for automatically processing payments.

Removes the default status from any other Payment Method.
| diff --git a/docs/linode-docs/providers/linode/account/payments/index.md b/docs/linode-docs/providers/linode/account/payments/index.md index 9eca68814e..293e978e78 100644 --- a/docs/linode-docs/providers/linode/account/payments/index.md +++ b/docs/linode-docs/providers/linode/account/payments/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepayments
TypeResource
Idlinode.account.payments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of the Payment. | -| `date` | `string` | When the Payment was made. | -| `usd` | `integer` | The amount, in US dollars, of the Payment. | +| | `integer` | The unique ID of the Payment. | +| | `string` | When the Payment was made. | +| | `integer` | The amount, in US dollars, of the Payment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPayment` | `SELECT` | `paymentId` | Returns information about a specific Payment.
| -| `getPayments` | `SELECT` | | Returns a paginated list of Payments made on this Account.
| -| `createPayment` | `INSERT` | `data__usd` | Makes a Payment to your Account.

* The requested amount is charged to the default Payment Method if no `payment_method_id` is specified.

* A `payment_submitted` event is generated when a payment is successfully submitted.
| -| `_getPayment` | `EXEC` | `paymentId` | Returns information about a specific Payment.
| -| `_getPayments` | `EXEC` | | Returns a paginated list of Payments made on this Account.
| +| | `SELECT` | | Returns information about a specific Payment.
| +| | `SELECT` | | Returns a paginated list of Payments made on this Account.
| +| | `INSERT` | | Makes a Payment to your Account.

* The requested amount is charged to the default Payment Method if no `payment_method_id` is specified.

* A `payment_submitted` event is generated when a payment is successfully submitted.
| +| | `EXEC` | | Returns information about a specific Payment.
| +| | `EXEC` | | Returns a paginated list of Payments made on this Account.
| diff --git a/docs/linode-docs/providers/linode/account/payments_paypal/index.md b/docs/linode-docs/providers/linode/account/payments_paypal/index.md index 807a0c25f9..d8e27d492b 100644 --- a/docs/linode-docs/providers/linode/account/payments_paypal/index.md +++ b/docs/linode-docs/providers/linode/account/payments_paypal/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepayments_paypal
TypeResource
Idlinode.account.payments_paypal
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createPayPalPayment` | `INSERT` | `data__cancel_url, data__redirect_url, data__usd` | -| `executePayPalPayment` | `EXEC` | `data__payer_id, data__payment_id` | +| | `INSERT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/account/promo_codes/index.md b/docs/linode-docs/providers/linode/account/promo_codes/index.md index dc4855c930..7f913061f5 100644 --- a/docs/linode-docs/providers/linode/account/promo_codes/index.md +++ b/docs/linode-docs/providers/linode/account/promo_codes/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepromo_codes
TypeResource
Idlinode.account.promo_codes
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createPromoCredit` | `INSERT` | `data__promo_code` | +| | `INSERT` | | diff --git a/docs/linode-docs/providers/linode/account/service_transfers/index.md b/docs/linode-docs/providers/linode/account/service_transfers/index.md index 9258486bb0..f9ca593f47 100644 --- a/docs/linode-docs/providers/linode/account/service_transfers/index.md +++ b/docs/linode-docs/providers/linode/account/service_transfers/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_transfers
TypeResource
Idlinode.account.service_transfers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `token` | `string` | The token used to identify and accept or cancel this transfer.
| -| `updated` | `string` | When this transfer was last updated.
| -| `created` | `string` | When this transfer was created.
| -| `entities` | `object` | A collection of the services to include in this transfer request, separated by type.
| -| `expiry` | `string` | When this transfer expires. Transfers will automatically expire 24 hours after creation.
| -| `is_sender` | `boolean` | If the requesting account created this transfer.
| -| `status` | `string` | The status of the transfer request.

`accepted`: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.

`cancelled`: The transfer has been cancelled by the sender.

`completed`: The transfer has completed successfully.

`failed`: The transfer has failed after initiation.

`pending`: The transfer is ready to be accepted.

`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or
cancelled.
| +| | `string` | When this transfer was created.
| +| | `object` | A collection of the services to include in this transfer request, separated by type.
| +| | `string` | When this transfer expires. Transfers will automatically expire 24 hours after creation.
| +| | `boolean` | If the requesting account created this transfer.
| +| | `string` | The status of the transfer request.

`accepted`: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.

`cancelled`: The transfer has been cancelled by the sender.

`completed`: The transfer has completed successfully.

`failed`: The transfer has failed after initiation.

`pending`: The transfer is ready to be accepted.

`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or
cancelled.
| +| | `string` | The token used to identify and accept or cancel this transfer.
| +| | `string` | When this transfer was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getServiceTransfer` | `SELECT` | `token` | Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user *of any account* can access this command. After a
transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and
accepted the transfer. If cancelled or expired, only unrestricted users of the account that created the
transfer can view it.
| -| `getServiceTransfers` | `SELECT` | | Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.

This command can only be accessed by the unrestricted users of an account.
| -| `createServiceTransfer` | `INSERT` | `data__entities` | Creates a transfer request for the specified services. A request can contain any of the specified service types
and any number of each service type. At this time, only Linodes can be transferred.

When created successfully, a confirmation email is sent to the account that created this transfer containing a
transfer token and instructions on completing the transfer.

When a transfer is [accepted](/docs/api/account/#service-transfer-accept), the requested services are moved to
the receiving account. Linode services will not experience interruptions due to the transfer process. Backups
for Linodes are transferred as well.

DNS records that are associated with requested services will not be transferred or updated. Please ensure that
associated DNS records have been updated or communicated to the recipient prior to the transfer.

A transfer can take up to three hours to complete once accepted. When a transfer is
completed, billing for transferred services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of an account.

There are several conditions that must be met in order to successfully create a transfer request:

1. The account creating the transfer must not have a past due balance or active Terms of Service violation.

1. The service must be owned by the account that is creating the transfer.

1. The service must not be assigned to another Service Transfer that is pending or that has been accepted and is
incomplete.

1. Linodes must not:

* be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.

* have any attached Block Storage Volumes.

* have any shared IP addresses.

* have any assigned /56, /64, or /116 IPv6 ranges.
| -| `deleteServiceTransfer` | `DELETE` | `token` | Cancels the Service Transfer for the provided token. Once cancelled, a transfer cannot be accepted or otherwise
acted on in any way. If cancelled in error, the transfer must be
[created](/docs/api/account/#service-transfer-create) again.

When cancelled, an email notification for the cancellation is sent to the account that created
this transfer. Transfers can not be cancelled if they are expired or have been accepted.

This command can only be accessed by the unrestricted users of the account that created this transfer.
| -| `_getServiceTransfer` | `EXEC` | `token` | Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user *of any account* can access this command. After a
transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and
accepted the transfer. If cancelled or expired, only unrestricted users of the account that created the
transfer can view it.
| -| `_getServiceTransfers` | `EXEC` | | Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.

This command can only be accessed by the unrestricted users of an account.
| -| `acceptServiceTransfer` | `EXEC` | `token` | Accept a Service Transfer for the provided token to receive the services included in the transfer to your
account. At this time, only Linodes can be transferred.

When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer
can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred
services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of the account that receives the transfer. Users
of the same account that created a transfer cannot accept the transfer.

There are several conditions that must be met in order to accept a transfer request:

1. Only transfers with a `pending` status can be accepted.

1. The account accepting the transfer must have a registered payment method and must not have a past due
balance or other account limitations for the services to be transferred.

1. Both the account that created the transfer and the account that is accepting the transfer must not have any
active Terms of Service violations.

1. The service must still be owned by the account that created the transfer.

1. Linodes must not:

* be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.

* have any attached Block Storage Volumes.

* have any shared IP addresses.

* have any assigned /56, /64, or /116 IPv6 ranges.

Any and all of the above conditions must be cured and maintained by the relevant account prior to the
transfer's expiration to allow the transfer to be accepted by the receiving account.
| +| | `SELECT` | | Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user *of any account* can access this command. After a
transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and
accepted the transfer. If cancelled or expired, only unrestricted users of the account that created the
transfer can view it.
| +| | `SELECT` | | Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.

This command can only be accessed by the unrestricted users of an account.
| +| | `INSERT` | | Creates a transfer request for the specified services. A request can contain any of the specified service types
and any number of each service type. At this time, only Linodes can be transferred.

When created successfully, a confirmation email is sent to the account that created this transfer containing a
transfer token and instructions on completing the transfer.

When a transfer is [accepted](/docs/api/account/#service-transfer-accept), the requested services are moved to
the receiving account. Linode services will not experience interruptions due to the transfer process. Backups
for Linodes are transferred as well.

DNS records that are associated with requested services will not be transferred or updated. Please ensure that
associated DNS records have been updated or communicated to the recipient prior to the transfer.

A transfer can take up to three hours to complete once accepted. When a transfer is
completed, billing for transferred services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of an account.

There are several conditions that must be met in order to successfully create a transfer request:

1. The account creating the transfer must not have a past due balance or active Terms of Service violation.

1. The service must be owned by the account that is creating the transfer.

1. The service must not be assigned to another Service Transfer that is pending or that has been accepted and is
incomplete.

1. Linodes must not:

* be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.

* have any attached Block Storage Volumes.

* have any shared IP addresses.

* have any assigned /56, /64, or /116 IPv6 ranges.
| +| | `DELETE` | | Cancels the Service Transfer for the provided token. Once cancelled, a transfer cannot be accepted or otherwise
acted on in any way. If cancelled in error, the transfer must be
[created](/docs/api/account/#service-transfer-create) again.

When cancelled, an email notification for the cancellation is sent to the account that created
this transfer. Transfers can not be cancelled if they are expired or have been accepted.

This command can only be accessed by the unrestricted users of the account that created this transfer.
| +| | `EXEC` | | Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user *of any account* can access this command. After a
transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and
accepted the transfer. If cancelled or expired, only unrestricted users of the account that created the
transfer can view it.
| +| | `EXEC` | | Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Accept a Service Transfer for the provided token to receive the services included in the transfer to your
account. At this time, only Linodes can be transferred.

When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer
can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred
services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of the account that receives the transfer. Users
of the same account that created a transfer cannot accept the transfer.

There are several conditions that must be met in order to accept a transfer request:

1. Only transfers with a `pending` status can be accepted.

1. The account accepting the transfer must have a registered payment method and must not have a past due
balance or other account limitations for the services to be transferred.

1. Both the account that created the transfer and the account that is accepting the transfer must not have any
active Terms of Service violations.

1. The service must still be owned by the account that created the transfer.

1. Linodes must not:

* be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.

* have any attached Block Storage Volumes.

* have any shared IP addresses.

* have any assigned /56, /64, or /116 IPv6 ranges.

Any and all of the above conditions must be cured and maintained by the relevant account prior to the
transfer's expiration to allow the transfer to be accepted by the receiving account.
| diff --git a/docs/linode-docs/providers/linode/account/settings/index.md b/docs/linode-docs/providers/linode/account/settings/index.md index c2b7955460..4a8755fabc 100644 --- a/docs/linode-docs/providers/linode/account/settings/index.md +++ b/docs/linode-docs/providers/linode/account/settings/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesettings
TypeResource
Idlinode.account.settings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `network_helper` | `boolean` | Enables network helper across all users by default for new Linodes and Linode Configs.
| -| `object_storage` | `string` | A string describing the status of this account's Object Storage service enrollment.
| -| `backups_enabled` | `boolean` | Account-wide backups default. If `true`, all Linodes created will automatically be enrolled in the Backups service. If `false`, Linodes will not be enrolled by default, but may still be enrolled on creation or later.
| -| `longview_subscription` | `string` | The Longview Pro tier you are currently subscribed to. The value must be a [Longview Subscription](/docs/api/longview/#longview-subscriptions-list) ID or `null` for Longview Free.
| -| `managed` | `boolean` | Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.
| +| | `boolean` | Account-wide backups default. If `true`, all Linodes created will automatically be enrolled in the Backups service. If `false`, Linodes will not be enrolled by default, but may still be enrolled on creation or later.
| +| | `string` | The Longview Pro tier you are currently subscribed to. The value must be a [Longview Subscription](/docs/api/longview/#longview-subscriptions-list) ID or `null` for Longview Free.
| +| | `boolean` | Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.
| +| | `boolean` | Enables network helper across all users by default for new Linodes and Linode Configs.
| +| | `string` | A string describing the status of this account's Object Storage service enrollment.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAccountSettings` | `SELECT` | | Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.
| -| `_getAccountSettings` | `EXEC` | | Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.
| -| `enableAccountManaged` | `EXEC` | | Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](/docs/guides/linode-managed/) to learn more.
| -| `updateAccountSettings` | `EXEC` | | Updates your Account settings.

To update your Longview subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| +| | `SELECT` | | Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.
| +| | `EXEC` | | Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.
| +| | `EXEC` | | Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](/docs/guides/linode-managed/) to learn more.
| +| | `EXEC` | | Updates your Account settings.

To update your Longview subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| diff --git a/docs/linode-docs/providers/linode/account/transfer/index.md b/docs/linode-docs/providers/linode/account/transfer/index.md index 918baf2a8b..e82e65966b 100644 --- a/docs/linode-docs/providers/linode/account/transfer/index.md +++ b/docs/linode-docs/providers/linode/account/transfer/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametransfer
TypeResource
Idlinode.account.transfer
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `billable` | `integer` | The amount of your transfer pool that is billable this billing cycle.
| -| `quota` | `integer` | The amount of network usage allowed this billing cycle.
| -| `used` | `integer` | The amount of network usage you have used this billing cycle.
| +| | `integer` | The amount of your transfer pool that is billable this billing cycle.
| +| | `integer` | The amount of network usage allowed this billing cycle.
| +| | `integer` | The amount of network usage you have used this billing cycle.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTransfer` | `SELECT` | | -| `_getTransfer` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/account/users/index.md b/docs/linode-docs/providers/linode/account/users/index.md index 665ccaaae8..9cdfa339b9 100644 --- a/docs/linode-docs/providers/linode/account/users/index.md +++ b/docs/linode-docs/providers/linode/account/users/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idlinode.account.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ssh_keys` | `array` | A list of SSH Key labels added by this User.

Users can add keys with the SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) command.

These keys are deployed when this User is included in the `authorized_users`
field of the following requests:
- Linode Create ([POST /linode/instances](/docs/api/linode-instances/#linode-create))
- Linode Rebuild ([POST /linode/instances/{linodeId}/rebuild](/docs/api/linode-instances/#linode-rebuild))
- Disk Create ([POST /linode/instances/{linodeId}/disks](/docs/api/linode-instances/#disk-create))
| -| `tfa_enabled` | `boolean` | A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) endpoint to enable TFA.
| -| `username` | `string` | The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).
| -| `email` | `string` | The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.
| -| `restricted` | `boolean` | If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ([GET /account/users/{username}/grants](/docs/api/account/#users-grants-view)) for details on how to configure grants for a restricted User.
| +| | `string` | The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.
| +| | `boolean` | If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ([GET /account/users/{username}/grants](/docs/api/account/#users-grants-view)) for details on how to configure grants for a restricted User.
| +| | `array` | A list of SSH Key labels added by this User.

Users can add keys with the SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) command.

These keys are deployed when this User is included in the `authorized_users`
field of the following requests:
- Linode Create ([POST /linode/instances](/docs/api/linode-instances/#linode-create))
- Linode Rebuild ([POST /linode/instances/{linodeId}/rebuild](/docs/api/linode-instances/#linode-rebuild))
- Disk Create ([POST /linode/instances/{linodeId}/disks](/docs/api/linode-instances/#disk-create))
| +| | `boolean` | A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) endpoint to enable TFA.
| +| | `string` | The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getUser` | `SELECT` | `username` | Returns information about a single User on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `getUsers` | `SELECT` | | Returns a paginated list of Users on your Account.

This command can only be accessed by the unrestricted users of an account.

Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
| -| `createUser` | `INSERT` | `data__email, data__username` | Creates a User on your Account. Once created, a confirmation message containing
password creation and login instructions is sent to the User's email address.

This command can only be accessed by the unrestricted users of an account.

The User's account access is determined by whether or not they are restricted,
and what grants they have been given.
| -| `deleteUser` | `DELETE` | `username` | Deletes a User. The deleted User will be immediately logged out and
may no longer log in or perform any actions. All of the User's Grants
will be removed.

This command can only be accessed by the unrestricted users of an account.
| -| `_getUser` | `EXEC` | `username` | Returns information about a single User on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `_getUserGrants` | `EXEC` | `username` | Returns the full grants structure for the specified account User
(other than the account owner, see below for details). This includes all entities
on the Account alongside the level of access this User has to each of them.

This command can only be accessed by the unrestricted users of an account.

The current authenticated User, including the account owner, may view their
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
endpoint, but will not see entities that they do not have access to.
| -| `_getUsers` | `EXEC` | | Returns a paginated list of Users on your Account.

This command can only be accessed by the unrestricted users of an account.

Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
| -| `getUserGrants` | `EXEC` | `username` | Returns the full grants structure for the specified account User
(other than the account owner, see below for details). This includes all entities
on the Account alongside the level of access this User has to each of them.

This command can only be accessed by the unrestricted users of an account.

The current authenticated User, including the account owner, may view their
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
endpoint, but will not see entities that they do not have access to.
| -| `updateUser` | `EXEC` | `username` | Update information about a User on your Account. This can be used to
change the restricted status of a User. When making a User restricted,
no grants will be configured by default and you must then set up grants
in order for the User to access anything on the Account.

This command can only be accessed by the unrestricted users of an account.
| -| `updateUserGrants` | `EXEC` | `username` | Update the grants a User has. This can be used to give a User access
to new entities or actions, or take access away. You do not need to
include the grant for every entity on the Account in this request; any
that are not included will remain unchanged.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns information about a single User on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of Users on your Account.

This command can only be accessed by the unrestricted users of an account.

Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
| +| | `INSERT` | | Creates a User on your Account. Once created, a confirmation message containing
password creation and login instructions is sent to the User's email address.

This command can only be accessed by the unrestricted users of an account.

The User's account access is determined by whether or not they are restricted,
and what grants they have been given.
| +| | `DELETE` | | Deletes a User. The deleted User will be immediately logged out and
may no longer log in or perform any actions. All of the User's Grants
will be removed.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns information about a single User on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns the full grants structure for the specified account User
(other than the account owner, see below for details). This includes all entities
on the Account alongside the level of access this User has to each of them.

This command can only be accessed by the unrestricted users of an account.

The current authenticated User, including the account owner, may view their
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
endpoint, but will not see entities that they do not have access to.
| +| | `EXEC` | | Returns a paginated list of Users on your Account.

This command can only be accessed by the unrestricted users of an account.

Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
| +| | `EXEC` | | Returns the full grants structure for the specified account User
(other than the account owner, see below for details). This includes all entities
on the Account alongside the level of access this User has to each of them.

This command can only be accessed by the unrestricted users of an account.

The current authenticated User, including the account owner, may view their
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
endpoint, but will not see entities that they do not have access to.
| +| | `EXEC` | | Update information about a User on your Account. This can be used to
change the restricted status of a User. When making a User restricted,
no grants will be configured by default and you must then set up grants
in order for the User to access anything on the Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Update the grants a User has. This can be used to give a User access
to new entities or actions, or take access away. You do not need to
include the grant for every entity on the Account in this request; any
that are not included will remain unchanged.

This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/databases/engines/index.md b/docs/linode-docs/providers/linode/databases/engines/index.md index 65fb960334..430bdbedc8 100644 --- a/docs/linode-docs/providers/linode/databases/engines/index.md +++ b/docs/linode-docs/providers/linode/databases/engines/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameengines
TypeResource
Idlinode.databases.engines
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The Managed Database engine ID in engine/version format. | -| `engine` | `string` | The Managed Database engine type. | -| `version` | `string` | The Managed Database engine version. | +| | `string` | The Managed Database engine ID in engine/version format. | +| | `string` | The Managed Database engine type. | +| | `string` | The Managed Database engine version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesEngine` | `SELECT` | `engineId` | Display information for a single Managed Database engine type and version.
| -| `getDatabasesEngines` | `SELECT` | | Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.
| -| `_getDatabasesEngine` | `EXEC` | `engineId` | Display information for a single Managed Database engine type and version.
| -| `_getDatabasesEngines` | `EXEC` | | Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.
| +| | `SELECT` | | Display information for a single Managed Database engine type and version.
| +| | `SELECT` | | Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.
| +| | `EXEC` | | Display information for a single Managed Database engine type and version.
| +| | `EXEC` | | Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.
| diff --git a/docs/linode-docs/providers/linode/databases/index.md b/docs/linode-docs/providers/linode/databases/index.md index 5ff3d98c8e..62ee2016c6 100644 --- a/docs/linode-docs/providers/linode/databases/index.md +++ b/docs/linode-docs/providers/linode/databases/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Databases :::info Service Summary diff --git a/docs/linode-docs/providers/linode/databases/instances/index.md b/docs/linode-docs/providers/linode/databases/instances/index.md index f0fd2592d8..e07a9dce12 100644 --- a/docs/linode-docs/providers/linode/databases/instances/index.md +++ b/docs/linode-docs/providers/linode/databases/instances/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinstances
TypeResource
Idlinode.databases.instances
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique ID that can be used to identify and reference the Managed Database. | -| `cluster_size` | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| -| `created` | `string` | When this Managed Database was created. | -| `hosts` | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | -| `type` | `string` | The Linode Instance type used by the Managed Database for its nodes. | -| `allow_list` | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| -| `region` | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | -| `engine` | `string` | The Managed Database engine type. | -| `status` | `string` | The operating status of the Managed Database. | -| `updates` | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | -| `encrypted` | `boolean` | Whether the Managed Databases is encrypted. | -| `instance_uri` | `string` | Append this to `https://api.linode.com` to run commands for the Managed Database.
| -| `updated` | `string` | When this Managed Database was last updated. | -| `label` | `string` | A unique, user-defined string referring to the Managed Database. | -| `version` | `string` | The Managed Database engine version. | +| | `integer` | A unique ID that can be used to identify and reference the Managed Database. | +| | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| +| | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| +| | `string` | When this Managed Database was created. | +| | `boolean` | Whether the Managed Databases is encrypted. | +| | `string` | The Managed Database engine type. | +| | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | +| | `string` | Append this to `https://api.linode.com` to run commands for the Managed Database.
| +| | `string` | A unique, user-defined string referring to the Managed Database. | +| | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | +| | `string` | The operating status of the Managed Database. | +| | `string` | The Linode Instance type used by the Managed Database for its nodes. | +| | `string` | When this Managed Database was last updated. | +| | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | +| | `string` | The Managed Database engine version. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDatabasesInstances` | `SELECT` | | -| `_getDatabasesInstances` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/databases/mongodb_instances/index.md b/docs/linode-docs/providers/linode/databases/mongodb_instances/index.md index a1bf84c881..c8066ac2b9 100644 --- a/docs/linode-docs/providers/linode/databases/mongodb_instances/index.md +++ b/docs/linode-docs/providers/linode/databases/mongodb_instances/index.md @@ -14,46 +14,49 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemongodb_instances
TypeResource
Idlinode.databases.mongodb_instances
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique ID that can be used to identify and reference the Managed Database. | -| `version` | `string` | The Managed Database engine version. | -| `status` | `string` | The operating status of the Managed Database. | -| `engine` | `string` | The Managed Database engine type. | -| `allow_list` | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| -| `port` | `integer` | The access port for this Managed Database. | -| `region` | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | -| `storage_engine` | `string` | The type of storage engine for this Database.

**Note:** MMAPV1 is not available for MongoDB versions 4.0 and above.
| -| `replica_set` | `string` | Label for configuring a MongoDB [replica set](https://www.mongodb.com/docs/manual/replication/). Choose the same label on multiple Databases to include them in the same replica set.

If `null`, the Database is not included in any replica set.
| -| `cluster_size` | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| -| `updated` | `string` | When this Managed Database was last updated. | -| `updates` | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | -| `label` | `string` | A unique, user-defined string referring to the Managed Database. | -| `peers` | `array` | An array of peer addresses for this Database.
| -| `encrypted` | `boolean` | Whether the Managed Databases is encrypted. | -| `type` | `string` | The Linode Instance type used by the Managed Database for its nodes. | -| `created` | `string` | When this Managed Database was created. | -| `ssl_connection` | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command for access information.
| -| `hosts` | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | -| `compression_type` | `string` | The type of data compression for this Database.

Snappy has a lower comparative compression ratio and resource consumption rate.

Zlip has a higher comparative compression ratio and resource consumption rate.
| +| | `integer` | A unique ID that can be used to identify and reference the Managed Database. | +| | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| +| | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| +| | `string` | The type of data compression for this Database.

Snappy has a lower comparative compression ratio and resource consumption rate.

Zlip has a higher comparative compression ratio and resource consumption rate.
| +| | `string` | When this Managed Database was created. | +| | `boolean` | Whether the Managed Databases is encrypted. | +| | `string` | The Managed Database engine type. | +| | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | +| | `string` | A unique, user-defined string referring to the Managed Database. | +| | `array` | An array of peer addresses for this Database.
| +| | `integer` | The access port for this Managed Database. | +| | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | +| | `string` | Label for configuring a MongoDB [replica set](https://www.mongodb.com/docs/manual/replication/). Choose the same label on multiple Databases to include them in the same replica set.

If `null`, the Database is not included in any replica set.
| +| | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command for access information.
| +| | `string` | The operating status of the Managed Database. | +| | `string` | The type of storage engine for this Database.

**Note:** MMAPV1 is not available for MongoDB versions 4.0 and above.
| +| | `string` | The Linode Instance type used by the Managed Database for its nodes. | +| | `string` | When this Managed Database was last updated. | +| | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | +| | `string` | The Managed Database engine version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMongoDBInstance` | `SELECT` | `instanceId` | Display information for a single, accessible Managed MongoDB Database.

**Note**: New MongoDB Databases cannot currently be created.
| -| `getDatabasesMongoDBInstances` | `SELECT` | | Display all accessible Managed MongoDB Databases.

**Note**: New MongoDB Databases cannot currently be created.
| -| `deleteDatabasesMongoDBInstance` | `DELETE` | `instanceId` | Remove a Managed MongoDB Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: New MongoDB Databases cannot currently be created.
| -| `_getDatabasesMongoDBInstance` | `EXEC` | `instanceId` | Display information for a single, accessible Managed MongoDB Database.

**Note**: New MongoDB Databases cannot currently be created.
| -| `_getDatabasesMongoDBInstances` | `EXEC` | | Display all accessible Managed MongoDB Databases.

**Note**: New MongoDB Databases cannot currently be created.
| -| `postDatabasesMongoDBInstancePatch` | `EXEC` | `instanceId` | Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**:

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

**Note**: New MongoDB Databases cannot currently be created.
| -| `putDatabasesMongoDBInstance` | `EXEC` | `instanceId` | Update a Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges on this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `SELECT` | | Display information for a single, accessible Managed MongoDB Database.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `SELECT` | | Display all accessible Managed MongoDB Databases.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `DELETE` | | Remove a Managed MongoDB Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Display information for a single, accessible Managed MongoDB Database.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Display all accessible Managed MongoDB Databases.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**:

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Update a Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges on this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

**Note**: New MongoDB Databases cannot currently be created.
| diff --git a/docs/linode-docs/providers/linode/databases/mongodb_instances_backups/index.md b/docs/linode-docs/providers/linode/databases/mongodb_instances_backups/index.md index 8ba4192453..6ef3995b46 100644 --- a/docs/linode-docs/providers/linode/databases/mongodb_instances_backups/index.md +++ b/docs/linode-docs/providers/linode/databases/mongodb_instances_backups/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemongodb_instances_backups
TypeResource
Idlinode.databases.mongodb_instances_backups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of the database backup object. | -| `type` | `string` | The type of database backup, determined by how the backup was created. | -| `created` | `string` | A time value given in a combined date and time format that represents when the database backup was created. | -| `label` | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `integer` | The ID of the database backup object. | +| | `string` | A time value given in a combined date and time format that represents when the database backup was created. | +| | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `string` | The type of database backup, determined by how the backup was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMongoDBInstanceBackup` | `SELECT` | `backupId, instanceId` | Display information for a single backup for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `getDatabasesMongoDBInstanceBackups` | `SELECT` | `instanceId` | Display all backups for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `deleteDatabaseMongoDBInstanceBackup` | `DELETE` | `backupId, instanceId` | Delete a single backup for an accessible Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `_getDatabasesMongoDBInstanceBackup` | `EXEC` | `backupId, instanceId` | Display information for a single backup for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `_getDatabasesMongoDBInstanceBackups` | `EXEC` | `instanceId` | Display all backups for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `postDatabasesMongoDBInstanceBackup` | `EXEC` | `instanceId, data__label` | Creates a snapshot backup of a Managed MongoDB Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.

**Note**: New MongoDB Databases cannot currently be created.
| -| `postDatabasesMongoDBInstanceBackupRestore` | `EXEC` | `backupId, instanceId` | Restore a backup to a Managed MongoDB Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `SELECT` | | Display information for a single backup for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `SELECT` | | Display all backups for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `DELETE` | | Delete a single backup for an accessible Managed MongoDB Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Display information for a single backup for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Display all backups for an accessible Managed MongoDB Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Creates a snapshot backup of a Managed MongoDB Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Restore a backup to a Managed MongoDB Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.

**Note**: New MongoDB Databases cannot currently be created.
| diff --git a/docs/linode-docs/providers/linode/databases/mongodb_instances_credentials/index.md b/docs/linode-docs/providers/linode/databases/mongodb_instances_credentials/index.md index e3c973d73c..5b1ab201bf 100644 --- a/docs/linode-docs/providers/linode/databases/mongodb_instances_credentials/index.md +++ b/docs/linode-docs/providers/linode/databases/mongodb_instances_credentials/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemongodb_instances_credentials
TypeResource
Idlinode.databases.mongodb_instances_credentials
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `username` | `string` | The root username for the Managed Database instance. | -| `password` | `string` | The randomly-generated root password for the Managed Database instance. | +| | `string` | The randomly-generated root password for the Managed Database instance. | +| | `string` | The root username for the Managed Database instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMongoDBInstanceCredentials` | `SELECT` | `instanceId` | Display the root username and password for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `_getDatabasesMongoDBInstanceCredentials` | `EXEC` | `instanceId` | Display the root username and password for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| -| `postDatabasesMongoDBInstanceCredentialsReset` | `EXEC` | `instanceId` | Reset the root password for a Managed MongoDB Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `SELECT` | | Display the root username and password for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Display the root username and password for an accessible Managed MongoDB Database.

The Database must have an `active` status to perform this command.

**Note**: New MongoDB Databases cannot currently be created.
| +| | `EXEC` | | Reset the root password for a Managed MongoDB Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.

**Note**: New MongoDB Databases cannot currently be created.
| diff --git a/docs/linode-docs/providers/linode/databases/mongodb_instances_ssl/index.md b/docs/linode-docs/providers/linode/databases/mongodb_instances_ssl/index.md index c45ffb3801..4326a0a267 100644 --- a/docs/linode-docs/providers/linode/databases/mongodb_instances_ssl/index.md +++ b/docs/linode-docs/providers/linode/databases/mongodb_instances_ssl/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemongodb_instances_ssl
TypeResource
Idlinode.databases.mongodb_instances_ssl
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDatabasesMongoDBInstanceSSL` | `SELECT` | `instanceId` | -| `_getDatabasesMongoDBInstanceSSL` | `EXEC` | `instanceId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/databases/mysql_instances/index.md b/docs/linode-docs/providers/linode/databases/mysql_instances/index.md index cecae2969d..e6d36be94c 100644 --- a/docs/linode-docs/providers/linode/databases/mysql_instances/index.md +++ b/docs/linode-docs/providers/linode/databases/mysql_instances/index.md @@ -14,44 +14,47 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemysql_instances
TypeResource
Idlinode.databases.mysql_instances
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique ID that can be used to identify and reference the Managed Database. | -| `updates` | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | -| `allow_list` | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| -| `created` | `string` | When this Managed Database was created. | -| `encrypted` | `boolean` | Whether the Managed Databases is encrypted. | -| `status` | `string` | The operating status of the Managed Database. | -| `replication_type` | `string` | The replication method used for the Managed Database.

Defaults to `none` for a single cluster and `semi_synch` for a high availability cluster.

Must be `none` for a single node cluster.

Must be `asynch` or `semi_synch` for a high availability cluster.
| -| `version` | `string` | The Managed Database engine version. | -| `ssl_connection` | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command for access information.
| -| `cluster_size` | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| -| `type` | `string` | The Linode Instance type used by the Managed Database for its nodes. | -| `engine` | `string` | The Managed Database engine type. | -| `region` | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | -| `port` | `integer` | The access port for this Managed Database. | -| `label` | `string` | A unique, user-defined string referring to the Managed Database. | -| `hosts` | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | -| `updated` | `string` | When this Managed Database was last updated. | +| | `integer` | A unique ID that can be used to identify and reference the Managed Database. | +| | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| +| | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| +| | `string` | When this Managed Database was created. | +| | `boolean` | Whether the Managed Databases is encrypted. | +| | `string` | The Managed Database engine type. | +| | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | +| | `string` | A unique, user-defined string referring to the Managed Database. | +| | `integer` | The access port for this Managed Database. | +| | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | +| | `string` | The replication method used for the Managed Database.

Defaults to `none` for a single cluster and `semi_synch` for a high availability cluster.

Must be `none` for a single node cluster.

Must be `asynch` or `semi_synch` for a high availability cluster.
| +| | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command for access information.
| +| | `string` | The operating status of the Managed Database. | +| | `string` | The Linode Instance type used by the Managed Database for its nodes. | +| | `string` | When this Managed Database was last updated. | +| | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | +| | `string` | The Managed Database engine version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMySQLInstance` | `SELECT` | `instanceId` | Display information for a single, accessible Managed MySQL Database.
| -| `getDatabasesMySQLInstances` | `SELECT` | | Display all accessible Managed MySQL Databases.
| -| `deleteDatabasesMySQLInstance` | `DELETE` | `instanceId` | Remove a Managed MySQL Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
| -| `_getDatabasesMySQLInstance` | `EXEC` | `instanceId` | Display information for a single, accessible Managed MySQL Database.
| -| `_getDatabasesMySQLInstances` | `EXEC` | | Display all accessible Managed MySQL Databases.
| -| `postDatabasesMySQLInstancePatch` | `EXEC` | `instanceId` | Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
| -| `postDatabasesMySQLInstances` | `EXEC` | `data__engine, data__label, data__region, data__type` | Provision a Managed MySQL Database.

Restricted Users must have the `add_databases` grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The `allow_list` is used to control access to the Managed Database.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.

* To modify update the maintenance window for a Database, use the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.
| -| `putDatabasesMySQLInstance` | `EXEC` | `instanceId` | Update a Managed MySQL Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
| +| | `SELECT` | | Display information for a single, accessible Managed MySQL Database.
| +| | `SELECT` | | Display all accessible Managed MySQL Databases.
| +| | `DELETE` | | Remove a Managed MySQL Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
| +| | `EXEC` | | Display information for a single, accessible Managed MySQL Database.
| +| | `EXEC` | | Display all accessible Managed MySQL Databases.
| +| | `EXEC` | | Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
| +| | `EXEC` | | Provision a Managed MySQL Database.

Restricted Users must have the `add_databases` grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The `allow_list` is used to control access to the Managed Database.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.

* To modify update the maintenance window for a Database, use the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.
| +| | `EXEC` | | Update a Managed MySQL Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
| diff --git a/docs/linode-docs/providers/linode/databases/mysql_instances_backups/index.md b/docs/linode-docs/providers/linode/databases/mysql_instances_backups/index.md index 0faa4067f6..4990860d1f 100644 --- a/docs/linode-docs/providers/linode/databases/mysql_instances_backups/index.md +++ b/docs/linode-docs/providers/linode/databases/mysql_instances_backups/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemysql_instances_backups
TypeResource
Idlinode.databases.mysql_instances_backups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of the database backup object. | -| `type` | `string` | The type of database backup, determined by how the backup was created. | -| `created` | `string` | A time value given in a combined date and time format that represents when the database backup was created. | -| `label` | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `integer` | The ID of the database backup object. | +| | `string` | A time value given in a combined date and time format that represents when the database backup was created. | +| | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `string` | The type of database backup, determined by how the backup was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMySQLInstanceBackup` | `SELECT` | `backupId, instanceId` | Display information for a single backup for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.
| -| `getDatabasesMySQLInstanceBackups` | `SELECT` | `instanceId` | Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
| -| `deleteDatabaseMySQLInstanceBackup` | `DELETE` | `backupId, instanceId` | Delete a single backup for an accessible Managed MySQL Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.
| -| `_getDatabasesMySQLInstanceBackup` | `EXEC` | `backupId, instanceId` | Display information for a single backup for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.
| -| `_getDatabasesMySQLInstanceBackups` | `EXEC` | `instanceId` | Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
| -| `postDatabasesMySQLInstanceBackup` | `EXEC` | `instanceId, data__label` | Creates a snapshot backup of a Managed MySQL Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
| -| `postDatabasesMySQLInstanceBackupRestore` | `EXEC` | `backupId, instanceId` | Restore a backup to a Managed MySQL Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
| +| | `SELECT` | | Display information for a single backup for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.
| +| | `SELECT` | | Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
| +| | `DELETE` | | Delete a single backup for an accessible Managed MySQL Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.
| +| | `EXEC` | | Display information for a single backup for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.
| +| | `EXEC` | | Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
| +| | `EXEC` | | Creates a snapshot backup of a Managed MySQL Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
| +| | `EXEC` | | Restore a backup to a Managed MySQL Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
| diff --git a/docs/linode-docs/providers/linode/databases/mysql_instances_credentials/index.md b/docs/linode-docs/providers/linode/databases/mysql_instances_credentials/index.md index 011db4cbbd..1ceaa6f9d6 100644 --- a/docs/linode-docs/providers/linode/databases/mysql_instances_credentials/index.md +++ b/docs/linode-docs/providers/linode/databases/mysql_instances_credentials/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemysql_instances_credentials
TypeResource
Idlinode.databases.mysql_instances_credentials
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `password` | `string` | The randomly-generated root password for the Managed Database instance. | -| `username` | `string` | The root username for the Managed Database instance. | +| | `string` | The randomly-generated root password for the Managed Database instance. | +| | `string` | The root username for the Managed Database instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesMySQLInstanceCredentials` | `SELECT` | `instanceId` | Display the root username and password for an accessible Managed MySQL Database.

The Database must have an `active` status to perform this command.
| -| `_getDatabasesMySQLInstanceCredentials` | `EXEC` | `instanceId` | Display the root username and password for an accessible Managed MySQL Database.

The Database must have an `active` status to perform this command.
| -| `postDatabasesMySQLInstanceCredentialsReset` | `EXEC` | `instanceId` | Reset the root password for a Managed MySQL Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.
| +| | `SELECT` | | Display the root username and password for an accessible Managed MySQL Database.

The Database must have an `active` status to perform this command.
| +| | `EXEC` | | Display the root username and password for an accessible Managed MySQL Database.

The Database must have an `active` status to perform this command.
| +| | `EXEC` | | Reset the root password for a Managed MySQL Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.
| diff --git a/docs/linode-docs/providers/linode/databases/mysql_instances_ssl/index.md b/docs/linode-docs/providers/linode/databases/mysql_instances_ssl/index.md index 592eb98fdc..f2cdbadab8 100644 --- a/docs/linode-docs/providers/linode/databases/mysql_instances_ssl/index.md +++ b/docs/linode-docs/providers/linode/databases/mysql_instances_ssl/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemysql_instances_ssl
TypeResource
Idlinode.databases.mysql_instances_ssl
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDatabasesMySQLInstanceSSL` | `SELECT` | `instanceId` | -| `_getDatabasesMySQLInstanceSSL` | `EXEC` | `instanceId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/databases/postgresql_instances/index.md b/docs/linode-docs/providers/linode/databases/postgresql_instances/index.md index f29b551b9e..d4bea93615 100644 --- a/docs/linode-docs/providers/linode/databases/postgresql_instances/index.md +++ b/docs/linode-docs/providers/linode/databases/postgresql_instances/index.md @@ -14,45 +14,48 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepostgresql_instances
TypeResource
Idlinode.databases.postgresql_instances
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | A unique ID that can be used to identify and reference the Managed Database. | -| `engine` | `string` | The Managed Database engine type. | -| `updated` | `string` | When this Managed Database was last updated. | -| `label` | `string` | A unique, user-defined string referring to the Managed Database. | -| `created` | `string` | When this Managed Database was created. | -| `type` | `string` | The Linode Instance type used by the Managed Database for its nodes. | -| `updates` | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | -| `cluster_size` | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| -| `region` | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | -| `encrypted` | `boolean` | Whether the Managed Databases is encrypted. | -| `replication_commit_type` | `string` | The synchronization level of the replicating server.

Must be `local` or `off` for the `asynch` replication type.

Must be `on`, `remote_write`, or `remote_apply` for the `semi_synch` replication type.
| -| `hosts` | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | -| `version` | `string` | The Managed Database engine version. | -| `port` | `integer` | The access port for this Managed Database. | -| `replication_type` | `string` | The replication method used for the Managed Database.

Defaults to `none` for a single cluster and `semi_synch` for a high availability cluster.

Must be `none` for a single node cluster.

Must be `asynch` or `semi_synch` for a high availability cluster.
| -| `status` | `string` | The operating status of the Managed Database. | -| `allow_list` | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| -| `ssl_connection` | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command for access information.
| +| | `integer` | A unique ID that can be used to identify and reference the Managed Database. | +| | `array` | A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.

If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.
| +| | `integer` | The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
| +| | `string` | When this Managed Database was created. | +| | `boolean` | Whether the Managed Databases is encrypted. | +| | `string` | The Managed Database engine type. | +| | `object` | The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete. | +| | `string` | A unique, user-defined string referring to the Managed Database. | +| | `integer` | The access port for this Managed Database. | +| | `string` | The [Region](/docs/api/regions/) ID for the Managed Database. | +| | `string` | The synchronization level of the replicating server.

Must be `local` or `off` for the `asynch` replication type.

Must be `on`, `remote_write`, or `remote_apply` for the `semi_synch` replication type.
| +| | `string` | The replication method used for the Managed Database.

Defaults to `none` for a single cluster and `semi_synch` for a high availability cluster.

Must be `none` for a single node cluster.

Must be `asynch` or `semi_synch` for a high availability cluster.
| +| | `boolean` | Whether to require SSL credentials to establish a connection to the Managed Database.

Use the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command for access information.
| +| | `string` | The operating status of the Managed Database. | +| | `string` | The Linode Instance type used by the Managed Database for its nodes. | +| | `string` | When this Managed Database was last updated. | +| | `object` | Configuration settings for automated patch update maintenance for the Managed Database. | +| | `string` | The Managed Database engine version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesPostgreSQLInstance` | `SELECT` | `instanceId` | Display information for a single, accessible Managed PostgreSQL Database.
| -| `getDatabasesPostgreSQLInstances` | `SELECT` | | Display all accessible Managed PostgreSQL Databases.
| -| `deleteDatabasesPostgreSQLInstance` | `DELETE` | `instanceId` | Remove a Managed PostgreSQL Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
| -| `_getDatabasesPostgreSQLInstance` | `EXEC` | `instanceId` | Display information for a single, accessible Managed PostgreSQL Database.
| -| `_getDatabasesPostgreSQLInstances` | `EXEC` | | Display all accessible Managed PostgreSQL Databases.
| -| `postDatabasesPostgreSQLInstancePatch` | `EXEC` | `instanceId` | Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
| -| `postDatabasesPostgreSQLInstances` | `EXEC` | `data__engine, data__label, data__region, data__type` | Provision a Managed PostgreSQL Database.

Restricted Users must have the `add_databases` grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The `allow_list` is used to control access to the Managed Database.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

* To modify update the maintenance window for a Database, use the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.
| -| `putDatabasesPostgreSQLInstance` | `EXEC` | `instanceId` | Update a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
| +| | `SELECT` | | Display information for a single, accessible Managed PostgreSQL Database.
| +| | `SELECT` | | Display all accessible Managed PostgreSQL Databases.
| +| | `DELETE` | | Remove a Managed PostgreSQL Database from your Account.

Requires `read_write` access to the Database.

The Database must have an `active`, `failed`, or `degraded` status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
| +| | `EXEC` | | Display information for a single, accessible Managed PostgreSQL Database.
| +| | `EXEC` | | Display all accessible Managed PostgreSQL Databases.
| +| | `EXEC` | | Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**

* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
| +| | `EXEC` | | Provision a Managed PostgreSQL Database.

Restricted Users must have the `add_databases` grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The `allow_list` is used to control access to the Managed Database.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.

* To modify update the maintenance window for a Database, use the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.
| +| | `EXEC` | | Update a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

Updating addresses in the `allow_list` overwrites any existing addresses.

* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.

* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.

* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.

* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.

* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.

* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
| diff --git a/docs/linode-docs/providers/linode/databases/postgresql_instances_backups/index.md b/docs/linode-docs/providers/linode/databases/postgresql_instances_backups/index.md index 178c0e5854..0e39f4af8d 100644 --- a/docs/linode-docs/providers/linode/databases/postgresql_instances_backups/index.md +++ b/docs/linode-docs/providers/linode/databases/postgresql_instances_backups/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepostgresql_instances_backups
TypeResource
Idlinode.databases.postgresql_instances_backups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of the database backup object. | -| `type` | `string` | The type of database backup, determined by how the backup was created. | -| `created` | `string` | A time value given in a combined date and time format that represents when the database backup was created. | -| `label` | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `integer` | The ID of the database backup object. | +| | `string` | A time value given in a combined date and time format that represents when the database backup was created. | +| | `string` | The database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
| +| | `string` | The type of database backup, determined by how the backup was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesPostgreSQLInstanceBackup` | `SELECT` | `backupId, instanceId` | Display information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
| -| `getDatabasesPostgreSQLInstanceBackups` | `SELECT` | `instanceId` | Display all backups for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed PostgreSQL Database Backup Snapshot Create** ([POST /databases/postgresql/instances/{instanceId}/backups](/docs/api/databases/#managed-postgresql-database-backup-snapshot-create)) command.
| -| `deleteDatabasePostgreSQLInstanceBackup` | `DELETE` | `backupId, instanceId` | Delete a single backup for an accessible Managed PostgreSQL Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.
| -| `_getDatabasesPostgreSQLInstanceBackup` | `EXEC` | `backupId, instanceId` | Display information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
| -| `_getDatabasesPostgreSQLInstanceBackups` | `EXEC` | `instanceId` | Display all backups for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed PostgreSQL Database Backup Snapshot Create** ([POST /databases/postgresql/instances/{instanceId}/backups](/docs/api/databases/#managed-postgresql-database-backup-snapshot-create)) command.
| -| `postDatabasesPostgreSQLInstanceBackup` | `EXEC` | `instanceId, data__label` | Creates a snapshot backup of a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
| -| `postDatabasesPostgreSQLInstanceBackupRestore` | `EXEC` | `backupId, instanceId` | Restore a backup to a Managed PostgreSQL Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
| +| | `SELECT` | | Display information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
| +| | `SELECT` | | Display all backups for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed PostgreSQL Database Backup Snapshot Create** ([POST /databases/postgresql/instances/{instanceId}/backups](/docs/api/databases/#managed-postgresql-database-backup-snapshot-create)) command.
| +| | `DELETE` | | Delete a single backup for an accessible Managed PostgreSQL Database.

Requires `read_write` access to the Database.

The Database must not be provisioning to perform this command.
| +| | `EXEC` | | Display information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
| +| | `EXEC` | | Display all backups for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.

Database `snapshot` type backups are created by accessing the **Managed PostgreSQL Database Backup Snapshot Create** ([POST /databases/postgresql/instances/{instanceId}/backups](/docs/api/databases/#managed-postgresql-database-backup-snapshot-create)) command.
| +| | `EXEC` | | Creates a snapshot backup of a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.
| +| | `EXEC` | | Restore a backup to a Managed PostgreSQL Database on your Account.

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
| diff --git a/docs/linode-docs/providers/linode/databases/postgresql_instances_credentials/index.md b/docs/linode-docs/providers/linode/databases/postgresql_instances_credentials/index.md index b440222312..2afb92651a 100644 --- a/docs/linode-docs/providers/linode/databases/postgresql_instances_credentials/index.md +++ b/docs/linode-docs/providers/linode/databases/postgresql_instances_credentials/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepostgresql_instances_credentials
TypeResource
Idlinode.databases.postgresql_instances_credentials
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `password` | `string` | The randomly-generated root password for the Managed Database instance. | -| `username` | `string` | The root username for the Managed Database instance. | +| | `string` | The randomly-generated root password for the Managed Database instance. | +| | `string` | The root username for the Managed Database instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesPostgreSQLInstanceCredentials` | `SELECT` | `instanceId` | Display the root username and password for an accessible Managed PostgreSQL Database.

The Database must have an `active` status to perform this command.
| -| `_getDatabasesPostgreSQLInstanceCredentials` | `EXEC` | `instanceId` | Display the root username and password for an accessible Managed PostgreSQL Database.

The Database must have an `active` status to perform this command.
| -| `postDatabasesPostgreSQLInstanceCredentialsReset` | `EXEC` | `instanceId` | Reset the root password for a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.
| +| | `SELECT` | | Display the root username and password for an accessible Managed PostgreSQL Database.

The Database must have an `active` status to perform this command.
| +| | `EXEC` | | Display the root username and password for an accessible Managed PostgreSQL Database.

The Database must have an `active` status to perform this command.
| +| | `EXEC` | | Reset the root password for a Managed PostgreSQL Database.

Requires `read_write` access to the Database.

A new root password is randomly generated and accessible with the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command.

Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.

**Note**: Note that it may take several seconds for credentials to reset.
| diff --git a/docs/linode-docs/providers/linode/databases/postgresql_instances_ssl/index.md b/docs/linode-docs/providers/linode/databases/postgresql_instances_ssl/index.md index 5ad056d02b..3838de0abc 100644 --- a/docs/linode-docs/providers/linode/databases/postgresql_instances_ssl/index.md +++ b/docs/linode-docs/providers/linode/databases/postgresql_instances_ssl/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepostgresql_instances_ssl
TypeResource
Idlinode.databases.postgresql_instances_ssl
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDatabasesPostgreSQLInstanceSSL` | `SELECT` | `instanceId` | -| `_getDatabasesPostgreSQLInstanceSSL` | `EXEC` | `instanceId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/databases/types/index.md b/docs/linode-docs/providers/linode/databases/types/index.md index e60ed07e39..626183b963 100644 --- a/docs/linode-docs/providers/linode/databases/types/index.md +++ b/docs/linode-docs/providers/linode/databases/types/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametypes
TypeResource
Idlinode.databases.types
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID representing the Managed Database node plan type. | -| `memory` | `integer` | The amount of RAM allocated to Database created of this plan type. The value is represented in megabytes. | -| `vcpus` | `integer` | The integer of number CPUs allocated to databases of this plan type. | -| `class` | `string` | The compute class category. | -| `deprecated` | `boolean` | Whether this Database plan type has been deprecated and is no longer available. | -| `disk` | `integer` | The amount of disk space set aside for Databases of this plan type. The value is represented in megabytes. | -| `engines` | `object` | | -| `label` | `string` | A human-readable string that describes each plan type. For display purposes only. | +| | `string` | The ID representing the Managed Database node plan type. | +| | `string` | The compute class category. | +| | `boolean` | Whether this Database plan type has been deprecated and is no longer available. | +| | `integer` | The amount of disk space set aside for Databases of this plan type. The value is represented in megabytes. | +| | `object` | | +| | `string` | A human-readable string that describes each plan type. For display purposes only. | +| | `integer` | The amount of RAM allocated to Database created of this plan type. The value is represented in megabytes. | +| | `integer` | The integer of number CPUs allocated to databases of this plan type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDatabasesType` | `SELECT` | `typeId` | Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.
| -| `getDatabasesTypes` | `SELECT` | | Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.

Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.
| -| `_getDatabasesType` | `EXEC` | `typeId` | Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.
| -| `_getDatabasesTypes` | `EXEC` | | Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.

Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.
| +| | `SELECT` | | Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.
| +| | `SELECT` | | Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.

Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.
| +| | `EXEC` | | Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.
| +| | `EXEC` | | Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.

Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.
| diff --git a/docs/linode-docs/providers/linode/domains/domains/index.md b/docs/linode-docs/providers/linode/domains/domains/index.md index b2c25ff6a8..b5dcc1c5ad 100644 --- a/docs/linode-docs/providers/linode/domains/domains/index.md +++ b/docs/linode-docs/providers/linode/domains/domains/index.md @@ -14,42 +14,45 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Idlinode.domains.domains
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Domain's unique ID | -| `description` | `string` | A description for this Domain. This is for display purposes only.
| -| `refresh_sec` | `integer` | The amount of time in seconds before this Domain should be refreshed.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 14400.
| -| `ttl_sec` | `integer` | "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
* Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
* Any other value is rounded up to the nearest valid value.
* A value of 0 is equivalent to the default value of 86400.
| -| `axfr_ips` | `array` | The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.

**Note**: This is potentially dangerous, and should be set to an empty list unless you intend to use it.
| -| `status` | `string` | Used to control whether this Domain is currently being rendered.
| -| `master_ips` | `array` | The IP addresses representing the master DNS for this Domain. At least one value is required for `type` slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.
| -| `domain` | `string` | The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to [RFC1035](https://tools.ietf.org/html/rfc1035). Domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two Domains representing the same domain.
| -| `group` | `string` | The group this Domain belongs to. This is for display purposes only.
| -| `tags` | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| -| `type` | `string` | Whether this Domain represents the authoritative source of information for the domain it describes ("master"), or whether it is a read-only copy of a master ("slave").
| -| `retry_sec` | `integer` | The interval, in seconds, at which a failed refresh should be retried.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 14400.
| -| `soa_email` | `string` | Start of Authority email address. This is required for `type` master Domains.
| -| `expire_sec` | `integer` | The amount of time in seconds that may pass before this Domain is no longer
authoritative.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 1209600.
| +| | `integer` | This Domain's unique ID | +| | `string` | A description for this Domain. This is for display purposes only.
| +| | `array` | The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.

**Note**: This is potentially dangerous, and should be set to an empty list unless you intend to use it.
| +| | `string` | The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to [RFC1035](https://tools.ietf.org/html/rfc1035). Domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two Domains representing the same domain.
| +| | `integer` | The amount of time in seconds that may pass before this Domain is no longer
authoritative.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 1209600.
| +| | `string` | The group this Domain belongs to. This is for display purposes only.
| +| | `array` | The IP addresses representing the master DNS for this Domain. At least one value is required for `type` slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.
| +| | `integer` | The amount of time in seconds before this Domain should be refreshed.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 14400.
| +| | `integer` | The interval, in seconds, at which a failed refresh should be retried.

* Valid values are
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

* Any other value is rounded up to the nearest valid value.

* A value of 0 is equivalent to the default value of 14400.
| +| | `string` | Start of Authority email address. This is required for `type` master Domains.
| +| | `string` | Used to control whether this Domain is currently being rendered.
| +| | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| +| | `integer` | "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
* Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
* Any other value is rounded up to the nearest valid value.
* A value of 0 is equivalent to the default value of 86400.
| +| | `string` | Whether this Domain represents the authoritative source of information for the domain it describes ("master"), or whether it is a read-only copy of a master ("slave").
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDomain` | `SELECT` | `domainId` | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers.
| -| `getDomains` | `SELECT` | | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers.
| -| `createDomain` | `INSERT` | `data__domain, data__type` | Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used.
| -| `deleteDomain` | `DELETE` | `domainId` | Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all associated Domain Records.
| -| `_getDomain` | `EXEC` | `domainId` | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers.
| -| `_getDomains` | `EXEC` | | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers.
| -| `cloneDomain` | `EXEC` | `domainId, data__domain` | Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager.
| -| `importDomain` | `EXEC` | `data__domain, data__remote_nameserver` | Imports a domain zone from a remote nameserver.
Your nameserver must allow zone transfers (AXFR) from the following IPs:

- 96.126.114.97
- 96.126.114.98
- 2600:3c00::5e
- 2600:3c00::5f
| -| `updateDomain` | `EXEC` | `domainId` | Update information about a Domain in Linode's DNS Manager.
| +| | `SELECT` | | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers.
| +| | `SELECT` | | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers.
| +| | `INSERT` | | Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used.
| +| | `DELETE` | | Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all associated Domain Records.
| +| | `EXEC` | | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers.
| +| | `EXEC` | | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers.
| +| | `EXEC` | | Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager.
| +| | `EXEC` | | Imports a domain zone from a remote nameserver.
Your nameserver must allow zone transfers (AXFR) from the following IPs:

- 96.126.114.97
- 96.126.114.98
- 2600:3c00::5e
- 2600:3c00::5f
| +| | `EXEC` | | Update information about a Domain in Linode's DNS Manager.
| diff --git a/docs/linode-docs/providers/linode/domains/index.md b/docs/linode-docs/providers/linode/domains/index.md index a1b0176533..51eb6d1ff8 100644 --- a/docs/linode-docs/providers/linode/domains/index.md +++ b/docs/linode-docs/providers/linode/domains/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Domains :::info Service Summary diff --git a/docs/linode-docs/providers/linode/domains/records/index.md b/docs/linode-docs/providers/linode/domains/records/index.md index 0b64265a5f..3ed5e9a134 100644 --- a/docs/linode-docs/providers/linode/domains/records/index.md +++ b/docs/linode-docs/providers/linode/domains/records/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerecords
TypeResource
Idlinode.domains.records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Record's unique ID. | -| `name` | `string` | The name of this Record. For requests, this property's actual usage and whether it is required depends
on the type of record this represents:

`A` and `AAAA`: The hostname or FQDN of the Record.

`NS`: The subdomain, if any, to use with the Domain of the Record. Wildcard NS records (`*`) are not supported.

`MX`: The mail subdomain. For example, `sub` for the address `user@sub.example.com` under the `example.com`
Domain. Must be an empty string (`""`) for a Null MX Record.

`CNAME`: The hostname. Must be unique. Required.

`TXT`: The hostname.

`SRV`: Unused. Use the `service` property to set the service name for this record.

`CAA`: The subdomain. Omit or enter an empty string (`""`) to apply to the entire Domain.

`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS
(rDNS)](/docs/guides/configure-rdns/).
| -| `created` | `string` | When this Domain Record was created. | -| `ttl_sec` | `integer` | "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
| -| `priority` | `integer` | The priority of the target host for this Record. Lower values are preferred. Only valid for
MX and SRV record requests. Required for SRV record requests.

Defaults to `0` for MX record requests. Must be `0` for Null MX records.
| -| `protocol` | `string` | The protocol this Record's service communicates with. An underscore (`_`) is prepended automatically to the submitted value for this property. Only valid for SRV record requests.
| -| `tag` | `string` | The tag portion of a CAA record. Only valid and required for CAA record requests.
| -| `target` | `string` | The target for this Record. For requests, this property's actual usage and whether it is required depends
on the type of record this represents:

`A` and `AAAA`: The IP address. Use `[remote_addr]` to submit the IPv4 address of the request. Required.

`NS`: The name server. Must be a valid domain. Required.

`MX`: The mail server. Must be a valid domain unless creating a Null MX Record. To create a
[Null MX Record](https://datatracker.ietf.org/doc/html/rfc7505), first
[remove](/docs/api/domains/#domain-record-delete) any additional MX records, create an MX record with empty strings
(`""`) for the `target` and `name`. If a Domain has a Null MX record, new MX records cannot be created. Required.

`CNAME`: The alias. Must be a valid domain. Required.

`TXT`: The value. Required.

`SRV`: The target domain or subdomain. If a subdomain is entered, it is automatically used with the Domain.
To configure for a different domain, enter a valid FQDN. For example, the value `www` with a Domain for
`example.com` results in a target set to `www.example.com`, whereas the value `sample.com` results in a
target set to `sample.com`. Required.

`CAA`: The value. For `issue` or `issuewild` tags, the domain of your certificate issuer. For the `iodef`
tag, a contact or submission URL (domain, http, https, or mailto). Requirements depend on the tag for this record:
* `issue`: The domain of your certificate issuer. Must be a valid domain.
* `issuewild`: The domain of your wildcard certificate issuer. Must be a valid domain and must not start with an asterisk (`*`).
* `iodef`: Must be either (1) a valid domain, (2) a valid domain prepended with `http://` or `https://`, or (3) a valid email address prepended with `mailto:`.

`PTR`: Required. See our guide on how to [Configure Your Linode for Reverse DNS
(rDNS)](/docs/guides/configure-rdns/).

With the exception of A, AAAA, and CAA records, this field accepts a trailing period.
| -| `updated` | `string` | When this Domain Record was last updated. | -| `weight` | `integer` | The relative weight of this Record used in the case of identical priority. Higher values are preferred. Only valid and required for SRV record requests.
| -| `port` | `integer` | The port this Record points to. Only valid and required for SRV record requests.
| -| `service` | `string` | The name of the service. An underscore (`_`) is prepended and a period (`.`) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.
| -| `type` | `string` | The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on [DNS Record Types](/docs/products/networking/dns-manager/guides/#dns-record-types).
| +| | `integer` | This Record's unique ID. | +| | `string` | The name of this Record. For requests, this property's actual usage and whether it is required depends
on the type of record this represents:

`A` and `AAAA`: The hostname or FQDN of the Record.

`NS`: The subdomain, if any, to use with the Domain of the Record. Wildcard NS records (`*`) are not supported.

`MX`: The mail subdomain. For example, `sub` for the address `user@sub.example.com` under the `example.com`
Domain. Must be an empty string (`""`) for a Null MX Record.

`CNAME`: The hostname. Must be unique. Required.

`TXT`: The hostname.

`SRV`: Unused. Use the `service` property to set the service name for this record.

`CAA`: The subdomain. Omit or enter an empty string (`""`) to apply to the entire Domain.

`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS
(rDNS)](/docs/guides/configure-rdns/).
| +| | `string` | When this Domain Record was created. | +| | `integer` | The port this Record points to. Only valid and required for SRV record requests.
| +| | `integer` | The priority of the target host for this Record. Lower values are preferred. Only valid for
MX and SRV record requests. Required for SRV record requests.

Defaults to `0` for MX record requests. Must be `0` for Null MX records.
| +| | `string` | The protocol this Record's service communicates with. An underscore (`_`) is prepended automatically to the submitted value for this property. Only valid for SRV record requests.
| +| | `string` | The name of the service. An underscore (`_`) is prepended and a period (`.`) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.
| +| | `string` | The tag portion of a CAA record. Only valid and required for CAA record requests.
| +| | `string` | The target for this Record. For requests, this property's actual usage and whether it is required depends
on the type of record this represents:

`A` and `AAAA`: The IP address. Use `[remote_addr]` to submit the IPv4 address of the request. Required.

`NS`: The name server. Must be a valid domain. Required.

`MX`: The mail server. Must be a valid domain unless creating a Null MX Record. To create a
[Null MX Record](https://datatracker.ietf.org/doc/html/rfc7505), first
[remove](/docs/api/domains/#domain-record-delete) any additional MX records, create an MX record with empty strings
(`""`) for the `target` and `name`. If a Domain has a Null MX record, new MX records cannot be created. Required.

`CNAME`: The alias. Must be a valid domain. Required.

`TXT`: The value. Required.

`SRV`: The target domain or subdomain. If a subdomain is entered, it is automatically used with the Domain.
To configure for a different domain, enter a valid FQDN. For example, the value `www` with a Domain for
`example.com` results in a target set to `www.example.com`, whereas the value `sample.com` results in a
target set to `sample.com`. Required.

`CAA`: The value. For `issue` or `issuewild` tags, the domain of your certificate issuer. For the `iodef`
tag, a contact or submission URL (domain, http, https, or mailto). Requirements depend on the tag for this record:
* `issue`: The domain of your certificate issuer. Must be a valid domain.
* `issuewild`: The domain of your wildcard certificate issuer. Must be a valid domain and must not start with an asterisk (`*`).
* `iodef`: Must be either (1) a valid domain, (2) a valid domain prepended with `http://` or `https://`, or (3) a valid email address prepended with `mailto:`.

`PTR`: Required. See our guide on how to [Configure Your Linode for Reverse DNS
(rDNS)](/docs/guides/configure-rdns/).

With the exception of A, AAAA, and CAA records, this field accepts a trailing period.
| +| | `integer` | "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
| +| | `string` | The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on [DNS Record Types](/docs/products/networking/dns-manager/guides/#dns-record-types).
| +| | `string` | When this Domain Record was last updated. | +| | `integer` | The relative weight of this Record used in the case of identical priority. Higher values are preferred. Only valid and required for SRV record requests.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDomainRecord` | `SELECT` | `domainId, recordId` | View a single Record on this Domain.
| -| `getDomainRecords` | `SELECT` | `domainId` | Returns a paginated list of Records configured on a Domain in Linode's
DNS Manager.
| -| `createDomainRecord` | `INSERT` | `domainId, data__type` | Adds a new Domain Record to the zonefile this Domain represents.

Each domain can have up to 12,000 active records.
| -| `deleteDomainRecord` | `DELETE` | `domainId, recordId` | Deletes a Record on this Domain.
| -| `_getDomainRecord` | `EXEC` | `domainId, recordId` | View a single Record on this Domain.
| -| `_getDomainRecords` | `EXEC` | `domainId` | Returns a paginated list of Records configured on a Domain in Linode's
DNS Manager.
| -| `updateDomainRecord` | `EXEC` | `domainId, recordId` | Updates a single Record on this Domain.
| +| | `SELECT` | | View a single Record on this Domain.
| +| | `SELECT` | | Returns a paginated list of Records configured on a Domain in Linode's
DNS Manager.
| +| | `INSERT` | | Adds a new Domain Record to the zonefile this Domain represents.

Each domain can have up to 12,000 active records.
| +| | `DELETE` | | Deletes a Record on this Domain.
| +| | `EXEC` | | View a single Record on this Domain.
| +| | `EXEC` | | Returns a paginated list of Records configured on a Domain in Linode's
DNS Manager.
| +| | `EXEC` | | Updates a single Record on this Domain.
| diff --git a/docs/linode-docs/providers/linode/domains/zone_file/index.md b/docs/linode-docs/providers/linode/domains/zone_file/index.md index c5920cc53e..5b9261e098 100644 --- a/docs/linode-docs/providers/linode/domains/zone_file/index.md +++ b/docs/linode-docs/providers/linode/domains/zone_file/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namezone_file
TypeResource
Idlinode.domains.zone_file
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDomainZone` | `SELECT` | `domainId` | -| `_getDomainZone` | `EXEC` | `domainId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/images/images/index.md b/docs/linode-docs/providers/linode/images/images/index.md index 93d3d8f6cc..d8222dfcf5 100644 --- a/docs/linode-docs/providers/linode/images/images/index.md +++ b/docs/linode-docs/providers/linode/images/images/index.md @@ -14,41 +14,44 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimages
TypeResource
Idlinode.images.images
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of this Image. | -| `description` | `string` | A detailed description of this Image. | -| `vendor` | `string` | The upstream distribution vendor. `None` for private Images.
| -| `created` | `string` | When this Image was created. | -| `deprecated` | `boolean` | Whether or not this Image is deprecated. Will only be true for deprecated public Images.
| -| `updated` | `string` | When this Image was last updated. | -| `expiry` | `string` | Only Images created automatically from a deleted Linode (type=automatic) will expire.
| -| `label` | `string` | A short description of the Image.
| -| `size` | `integer` | The minimum size this Image needs to deploy. Size is in MB.
| -| `created_by` | `string` | The name of the User who created this Image, or "linode" for public Images.
| -| `is_public` | `boolean` | True if the Image is a public distribution image. False if Image is private Account-specific Image. | -| `status` | `string` | The current status of this Image.

Only Images in an "available" status can be deployed. Images in a "creating" status are being created from a Linode Disk, and will become "available" shortly. Images in a "pending_upload" status are waiting for data to be [uploaded](/docs/api/images/#image-upload), and become "available" after the upload and processing are complete.

The "+order_by" and "+order" operators are not available for [filtering](/docs/api/#filtering-and-sorting) on this key.
| -| `type` | `string` | How the Image was created.

"Manual" Images can be created at any time.

"Automatic" Images are created automatically from a deleted Linode.
| -| `eol` | `string` | The date of the public Image's planned end of life. `None` for private Images.
| +| | `string` | The unique ID of this Image. | +| | `string` | A detailed description of this Image. | +| | `string` | When this Image was created. | +| | `string` | The name of the User who created this Image, or "linode" for public Images.
| +| | `boolean` | Whether or not this Image is deprecated. Will only be true for deprecated public Images.
| +| | `string` | The date of the public Image's planned end of life. `None` for private Images.
| +| | `string` | Only Images created automatically from a deleted Linode (type=automatic) will expire.
| +| | `boolean` | True if the Image is a public distribution image. False if Image is private Account-specific Image. | +| | `string` | A short description of the Image.
| +| | `integer` | The minimum size this Image needs to deploy. Size is in MB.
| +| | `string` | The current status of this Image.

Only Images in an "available" status can be deployed. Images in a "creating" status are being created from a Linode Disk, and will become "available" shortly. Images in a "pending_upload" status are waiting for data to be [uploaded](/docs/api/images/#image-upload), and become "available" after the upload and processing are complete.

The "+order_by" and "+order" operators are not available for [filtering](/docs/api/#filtering-and-sorting) on this key.
| +| | `string` | How the Image was created.

"Manual" Images can be created at any time.

"Automatic" Images are created automatically from a deleted Linode.
| +| | `string` | When this Image was last updated. | +| | `string` | The upstream distribution vendor. `None` for private Images.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getImage` | `SELECT` | `imageId` | Get information about a single Image.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
| -| `getImages` | `SELECT` | | Returns a paginated list of Images.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
| -| `createImage` | `INSERT` | `data__disk_id` | Captures a private gold-master Image from a Linode Disk.
| -| `deleteImage` | `DELETE` | `imageId` | Deletes a private Image you have permission to `read_write`.


**Deleting an Image is a destructive action and cannot be undone.**
| -| `_getImage` | `EXEC` | `imageId` | Get information about a single Image.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
| -| `_getImages` | `EXEC` | | Returns a paginated list of Images.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
| -| `post_images_upload` | `EXEC` | `data__label, data__region` | Initiates an Image upload.

This endpoint creates a new private Image object and returns it along
with the URL to which image data can be uploaded.

- Image data must be uploaded within 24 hours of creation or the
upload will be cancelled and the image deleted.

- Image uploads should be made as an HTTP PUT request to the URL returned in the `upload_to`
response parameter, with a `Content-type: application/octet-stream` header included in the
request. For example:

curl -v \
-H "Content-Type: application/octet-stream" \
--upload-file example.img.gz \
$UPLOAD_URL \
--progress-bar \
--output /dev/null

- Uploaded image data should be compressed in gzip (`.gz`) format. The uncompressed disk should be in raw
disk image (`.img`) format. A maximum compressed file size of 5GB is supported for upload at this time.

**Note:** To initiate and complete an Image upload in a single step, see our guide on how to [Upload an Image](/docs/products/tools/images/guides/upload-an-image/) using Cloud Manager or the Linode CLI `image-upload` plugin.
| -| `updateImage` | `EXEC` | `imageId` | Updates a private Image that you have permission to `read_write`.
| +| | `SELECT` | | Get information about a single Image.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
| +| | `SELECT` | | Returns a paginated list of Images.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
| +| | `INSERT` | | Captures a private gold-master Image from a Linode Disk.
| +| | `DELETE` | | Deletes a private Image you have permission to `read_write`.


**Deleting an Image is a destructive action and cannot be undone.**
| +| | `EXEC` | | Get information about a single Image.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.
| +| | `EXEC` | | Returns a paginated list of Images.

* **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
all users.

* **Private** Images have IDs that begin with "private/". These Images are Account-specific and only
accessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).

* To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.
| +| | `EXEC` | | Initiates an Image upload.

This endpoint creates a new private Image object and returns it along
with the URL to which image data can be uploaded.

- Image data must be uploaded within 24 hours of creation or the
upload will be cancelled and the image deleted.

- Image uploads should be made as an HTTP PUT request to the URL returned in the `upload_to`
response parameter, with a `Content-type: application/octet-stream` header included in the
request. For example:

curl -v \
-H "Content-Type: application/octet-stream" \
--upload-file example.img.gz \
$UPLOAD_URL \
--progress-bar \
--output /dev/null

- Uploaded image data should be compressed in gzip (`.gz`) format. The uncompressed disk should be in raw
disk image (`.img`) format. A maximum compressed file size of 5GB is supported for upload at this time.

**Note:** To initiate and complete an Image upload in a single step, see our guide on how to [Upload an Image](/docs/products/tools/images/guides/upload-an-image/) using Cloud Manager or the Linode CLI `image-upload` plugin.
| +| | `EXEC` | | Updates a private Image that you have permission to `read_write`.
| diff --git a/docs/linode-docs/providers/linode/images/index.md b/docs/linode-docs/providers/linode/images/index.md index 0f91bf500c..1de72a2821 100644 --- a/docs/linode-docs/providers/linode/images/index.md +++ b/docs/linode-docs/providers/linode/images/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Images :::info Service Summary diff --git a/docs/linode-docs/providers/linode/instances/backups/index.md b/docs/linode-docs/providers/linode/instances/backups/index.md index 9e23c0c3d1..5dd92e61e8 100644 --- a/docs/linode-docs/providers/linode/instances/backups/index.md +++ b/docs/linode-docs/providers/linode/instances/backups/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebackups
TypeResource
Idlinode.instances.backups
Id
## Fields | Name | Datatype | |:-----|:---------| -| `snapshot` | `object` | -| `automatic` | `array` | +| | `array` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getBackup` | `SELECT` | `backupId, linodeId` | Returns information about a Backup.
| -| `getBackups` | `SELECT` | `linodeId` | Returns information about this Linode's available backups.
| -| `createSnapshot` | `INSERT` | `linodeId, data__label` | Creates a snapshot Backup of a Linode.

**Important:** If you already have a snapshot of this Linode, this is a destructive
action. The previous snapshot will be deleted.
| -| `_getBackup` | `EXEC` | `backupId, linodeId` | Returns information about a Backup.
| -| `_getBackups` | `EXEC` | `linodeId` | Returns information about this Linode's available backups.
| -| `cancelBackups` | `EXEC` | `linodeId` | Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever.
| -| `enableBackups` | `EXEC` | `linodeId` | Enables backups for the specified Linode.
| -| `restoreBackup` | `EXEC` | `backupId, linodeId, data__linode_id` | Restores a Linode's Backup to the specified Linode.
| +| | `SELECT` | | Returns information about a Backup.
| +| | `SELECT` | | Returns information about this Linode's available backups.
| +| | `INSERT` | | Creates a snapshot Backup of a Linode.

**Important:** If you already have a snapshot of this Linode, this is a destructive
action. The previous snapshot will be deleted.
| +| | `EXEC` | | Returns information about a Backup.
| +| | `EXEC` | | Returns information about this Linode's available backups.
| +| | `EXEC` | | Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever.
| +| | `EXEC` | | Enables backups for the specified Linode.
| +| | `EXEC` | | Restores a Linode's Backup to the specified Linode.
| diff --git a/docs/linode-docs/providers/linode/instances/configs/index.md b/docs/linode-docs/providers/linode/instances/configs/index.md index 503dc4835a..0e314d131b 100644 --- a/docs/linode-docs/providers/linode/instances/configs/index.md +++ b/docs/linode-docs/providers/linode/instances/configs/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfigs
TypeResource
Idlinode.instances.configs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of this Config. | -| `root_device` | `string` | The root device to boot.
* If no value or an invalid value is provided, root device will default to `/dev/sda`.
* If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.
| -| `virt_mode` | `string` | Controls the virtualization mode. Defaults to `paravirt`.
* `paravirt` is suitable for most cases. Linodes running in paravirt mode
share some qualities with the host, ultimately making it run faster since
there is less transition between it and the host.
* `fullvirt` affords more customization, but is slower because 100% of the VM
is virtualized.
| -| `comments` | `string` | Optional field for arbitrary User comments on this Config. | -| `kernel` | `string` | A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit". | -| `memory_limit` | `integer` | Defaults to the total RAM of the Linode.
| -| `helpers` | `object` | Helpers enabled when booting to this Linode Config. | -| `label` | `string` | The Config's label is for display purposes only.
| -| `run_level` | `string` | Defines the state of your Linode after booting. Defaults to `default`.
| -| `devices` | `object` | A dictionary of device disks to use as a device map in a Linode's configuration profile.
* An empty device disk dictionary or a dictionary with empty values for device slots is allowed.
* If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
| -| `interfaces` | `array` | An array of Network Interfaces to add to this Linode's Configuration Profile.

Up to three interface objects can be entered in this array. The position in the array determines the interface to which the settings apply:

- First/0: eth0
- Second/1: eth1
- Third/2: eth2

When updating a Linode's interfaces, *each interface must be redefined*. An empty interfaces array results in a default public interface configuration only.

If no public interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.

**Note:** Changes to Linode interface configurations can be enabled by rebooting the Linode.

**Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint to view the capabilities of data center regions.
If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center,
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
you will be prompted to select a different data center or contact support.

**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
| +| | `integer` | The ID of this Config. | +| | `string` | Optional field for arbitrary User comments on this Config. | +| | `object` | A dictionary of device disks to use as a device map in a Linode's configuration profile.
* An empty device disk dictionary or a dictionary with empty values for device slots is allowed.
* If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
| +| | `object` | Helpers enabled when booting to this Linode Config. | +| | `array` | An array of Network Interfaces to add to this Linode's Configuration Profile.

Up to three interface objects can be entered in this array. The position in the array determines the interface to which the settings apply:

- First/0: eth0
- Second/1: eth1
- Third/2: eth2

When updating a Linode's interfaces, *each interface must be redefined*. An empty interfaces array results in a default public interface configuration only.

If no public interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.

**Note:** Changes to Linode interface configurations can be enabled by rebooting the Linode.

**Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint to view the capabilities of data center regions.
If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center,
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
you will be prompted to select a different data center or contact support.

**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
| +| | `string` | A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit". | +| | `string` | The Config's label is for display purposes only.
| +| | `integer` | Defaults to the total RAM of the Linode.
| +| | `string` | The root device to boot.
* If no value or an invalid value is provided, root device will default to `/dev/sda`.
* If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.
| +| | `string` | Defines the state of your Linode after booting. Defaults to `default`.
| +| | `string` | Controls the virtualization mode. Defaults to `paravirt`.
* `paravirt` is suitable for most cases. Linodes running in paravirt mode
share some qualities with the host, ultimately making it run faster since
there is less transition between it and the host.
* `fullvirt` affords more customization, but is slower because 100% of the VM
is virtualized.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeConfig` | `SELECT` | `configId, linodeId` | Returns information about a specific Configuration profile.
| -| `getLinodeConfigs` | `SELECT` | `linodeId` | Lists Configuration profiles associated with a Linode.
| -| `addLinodeConfig` | `INSERT` | `linodeId, data__devices, data__label` | Adds a new Configuration profile to a Linode.
| -| `deleteLinodeConfig` | `DELETE` | `configId, linodeId` | Deletes the specified Configuration profile from the specified Linode.
| -| `_getLinodeConfig` | `EXEC` | `configId, linodeId` | Returns information about a specific Configuration profile.
| -| `_getLinodeConfigs` | `EXEC` | `linodeId` | Lists Configuration profiles associated with a Linode.
| -| `updateLinodeConfig` | `EXEC` | `configId, linodeId` | Updates a Configuration profile.
| +| | `SELECT` | | Returns information about a specific Configuration profile.
| +| | `SELECT` | | Lists Configuration profiles associated with a Linode.
| +| | `INSERT` | | Adds a new Configuration profile to a Linode.
| +| | `DELETE` | | Deletes the specified Configuration profile from the specified Linode.
| +| | `EXEC` | | Returns information about a specific Configuration profile.
| +| | `EXEC` | | Lists Configuration profiles associated with a Linode.
| +| | `EXEC` | | Updates a Configuration profile.
| diff --git a/docs/linode-docs/providers/linode/instances/disks/index.md b/docs/linode-docs/providers/linode/instances/disks/index.md index 84af1c903d..259ab0793d 100644 --- a/docs/linode-docs/providers/linode/instances/disks/index.md +++ b/docs/linode-docs/providers/linode/instances/disks/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedisks
TypeResource
Idlinode.instances.disks
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Disk's ID which must be provided for all operations impacting this Disk.
| -| `created` | `string` | When this Disk was created. | -| `filesystem` | `string` | The Disk filesystem can be one of:

* raw - No filesystem, just a raw binary stream.
* swap - Linux swap area.
* ext3 - The ext3 journaling filesystem for Linux.
* ext4 - The ext4 journaling filesystem for Linux.
* initrd - initrd (uncompressed initrd, ext2, max 32 MB).
| -| `label` | `string` | The Disk's label is for display purposes only.
| -| `size` | `integer` | The size of the Disk in MB. | -| `status` | `string` | A brief description of this Disk's current state. This field may change without direct action from you, as a result of operations performed to the Disk or the Linode containing the Disk.
| -| `updated` | `string` | When this Disk was last updated. | +| | `integer` | This Disk's ID which must be provided for all operations impacting this Disk.
| +| | `string` | When this Disk was created. | +| | `string` | The Disk filesystem can be one of:

* raw - No filesystem, just a raw binary stream.
* swap - Linux swap area.
* ext3 - The ext3 journaling filesystem for Linux.
* ext4 - The ext4 journaling filesystem for Linux.
* initrd - initrd (uncompressed initrd, ext2, max 32 MB).
| +| | `string` | The Disk's label is for display purposes only.
| +| | `integer` | The size of the Disk in MB. | +| | `string` | A brief description of this Disk's current state. This field may change without direct action from you, as a result of operations performed to the Disk or the Linode containing the Disk.
| +| | `string` | When this Disk was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeDisk` | `SELECT` | `diskId, linodeId` | View Disk information for a Disk associated with this Linode.
| -| `getLinodeDisks` | `SELECT` | `linodeId` | View Disk information for Disks associated with this Linode.
| -| `addLinodeDisk` | `INSERT` | `linodeId, data__size` | Adds a new Disk to a Linode.

* You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request.

* When creating an Empty Disk, providing a `label` is required.

* If no `label` is provided, an `image` is required instead.

* When creating a Disk from an Image, `root_pass` is required.

* The default filesystem for new Disks is `ext4`. If creating a Disk from an Image, the filesystem
of the Image is used unless otherwise specified.

* When deploying a StackScript on a Disk:
* See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for
a list of available StackScripts.
* Requires a compatible Image to be supplied.
* See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with their Profiles first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.
| -| `deleteDisk` | `DELETE` | `diskId, linodeId` | Deletes a Disk you have permission to `read_write`.

**Deleting a Disk is a destructive action and cannot be undone.**
| -| `_getLinodeDisk` | `EXEC` | `diskId, linodeId` | View Disk information for a Disk associated with this Linode.
| -| `_getLinodeDisks` | `EXEC` | `linodeId` | View Disk information for Disks associated with this Linode.
| -| `cloneLinodeDisk` | `EXEC` | `diskId, linodeId` | Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail.
| -| `resetDiskPassword` | `EXEC` | `diskId, linodeId, data__password` | Resets the password of a Disk you have permission to `read_write`.
| -| `resizeDisk` | `EXEC` | `diskId, linodeId, data__size` | Resizes a Disk you have permission to `read_write`.

The Disk must not be in use. If the Disk is in use, the request will
succeed but the resize will ultimately fail. For a request to succeed,
the Linode must be shut down prior to resizing the Disk, or the Disk
must not be assigned to the Linode's active Configuration Profile.

If you are resizing the Disk to a smaller size, it cannot be made smaller
than what is required by the total size of the files current on the Disk.
| -| `updateDisk` | `EXEC` | `diskId, linodeId` | Updates a Disk that you have permission to `read_write`.
| +| | `SELECT` | | View Disk information for a Disk associated with this Linode.
| +| | `SELECT` | | View Disk information for Disks associated with this Linode.
| +| | `INSERT` | | Adds a new Disk to a Linode.

* You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request.

* When creating an Empty Disk, providing a `label` is required.

* If no `label` is provided, an `image` is required instead.

* When creating a Disk from an Image, `root_pass` is required.

* The default filesystem for new Disks is `ext4`. If creating a Disk from an Image, the filesystem
of the Image is used unless otherwise specified.

* When deploying a StackScript on a Disk:
* See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for
a list of available StackScripts.
* Requires a compatible Image to be supplied.
* See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with their Profiles first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.
| +| | `DELETE` | | Deletes a Disk you have permission to `read_write`.

**Deleting a Disk is a destructive action and cannot be undone.**
| +| | `EXEC` | | View Disk information for a Disk associated with this Linode.
| +| | `EXEC` | | View Disk information for Disks associated with this Linode.
| +| | `EXEC` | | Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail.
| +| | `EXEC` | | Resets the password of a Disk you have permission to `read_write`.
| +| | `EXEC` | | Resizes a Disk you have permission to `read_write`.

The Disk must not be in use. If the Disk is in use, the request will
succeed but the resize will ultimately fail. For a request to succeed,
the Linode must be shut down prior to resizing the Disk, or the Disk
must not be assigned to the Linode's active Configuration Profile.

If you are resizing the Disk to a smaller size, it cannot be made smaller
than what is required by the total size of the files current on the Disk.
| +| | `EXEC` | | Updates a Disk that you have permission to `read_write`.
| diff --git a/docs/linode-docs/providers/linode/instances/firewalls/index.md b/docs/linode-docs/providers/linode/instances/firewalls/index.md index 32961eda39..6c28cbcb69 100644 --- a/docs/linode-docs/providers/linode/instances/firewalls/index.md +++ b/docs/linode-docs/providers/linode/instances/firewalls/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls
TypeResource
Idlinode.instances.firewalls
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The Firewall's unique ID.
| -| `status` | `string` | The status of this Firewall.

* When a Firewall is first created its status is `enabled`.
* Use the [Update Firewall](/docs/api/networking/#firewall-update) endpoint to set a Firewall's status to `enabled` or `disabled`.
* Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.
| -| `tags` | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| -| `updated` | `string` | When this Firewall was last updated.
| -| `created` | `string` | When this Firewall was created.
| -| `label` | `string` | The Firewall's label, for display purposes only.

Firewall labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
* Must be between 3 and 32 characters.
* Must be unique.
| -| `rules` | `object` | The inbound and outbound access rules to apply to the Firewall.

A Firewall may have up to 25 rules across its inbound and outbound rulesets.
| +| | `integer` | The Firewall's unique ID.
| +| | `string` | When this Firewall was created.
| +| | `string` | The Firewall's label, for display purposes only.

Firewall labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
* Must be between 3 and 32 characters.
* Must be unique.
| +| | `object` | The inbound and outbound access rules to apply to the Firewall.

A Firewall may have up to 25 rules across its inbound and outbound rulesets.
| +| | `string` | The status of this Firewall.

* When a Firewall is first created its status is `enabled`.
* Use the [Update Firewall](/docs/api/networking/#firewall-update) endpoint to set a Firewall's status to `enabled` or `disabled`.
* Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.
| +| | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | When this Firewall was last updated.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLinodeFirewalls` | `SELECT` | `linodeId` | -| `_getLinodeFirewalls` | `EXEC` | `linodeId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/instances/index.md b/docs/linode-docs/providers/linode/instances/index.md index f4f2579086..1848de0fa7 100644 --- a/docs/linode-docs/providers/linode/instances/index.md +++ b/docs/linode-docs/providers/linode/instances/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Linode :::info Service Summary diff --git a/docs/linode-docs/providers/linode/instances/ips/index.md b/docs/linode-docs/providers/linode/instances/ips/index.md index 5bde8be9eb..e3f15952f5 100644 --- a/docs/linode-docs/providers/linode/instances/ips/index.md +++ b/docs/linode-docs/providers/linode/instances/ips/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameips
TypeResource
Idlinode.instances.ips
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ipv4` | `object` | Information about this Linode's IPv4 addresses.
| -| `ipv6` | `object` | Information about this Linode's IPv6 addresses.
| +| | `object` | Information about this Linode's IPv4 addresses.
| +| | `object` | Information about this Linode's IPv6 addresses.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeIP` | `SELECT` | `address, linodeId` | View information about the specified IP address associated with the specified Linode.
| -| `getLinodeIPs` | `SELECT` | `linodeId` | Returns networking information for a single Linode.
| -| `addLinodeIP` | `INSERT` | `linodeId, data__public, data__type` | Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [open a support ticket](/docs/api/support/#support-ticket-open). You may not add more than one private IPv4 address to a single Linode.
| -| `removeLinodeIP` | `DELETE` | `address, linodeId` | Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address.
| -| `_getLinodeIP` | `EXEC` | `address, linodeId` | View information about the specified IP address associated with the specified Linode.
| -| `_getLinodeIPs` | `EXEC` | `linodeId` | Returns networking information for a single Linode.
| -| `updateLinodeIP` | `EXEC` | `address, linodeId, data__rdns` | Updates a the reverse DNS (RDNS) for a particular IP Address associated with this Linode.

Setting the RDNS to `null` for a public IPv4 address, resets it to the default "ip.linodeusercontent.com" RDNS value.
| +| | `SELECT` | | View information about the specified IP address associated with the specified Linode.
| +| | `SELECT` | | Returns networking information for a single Linode.
| +| | `INSERT` | | Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [open a support ticket](/docs/api/support/#support-ticket-open). You may not add more than one private IPv4 address to a single Linode.
| +| | `DELETE` | | Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address.
| +| | `EXEC` | | View information about the specified IP address associated with the specified Linode.
| +| | `EXEC` | | Returns networking information for a single Linode.
| +| | `EXEC` | | Updates a the reverse DNS (RDNS) for a particular IP Address associated with this Linode.

Setting the RDNS to `null` for a public IPv4 address, resets it to the default "ip.linodeusercontent.com" RDNS value.
| diff --git a/docs/linode-docs/providers/linode/instances/kernels/index.md b/docs/linode-docs/providers/linode/instances/kernels/index.md index 542d05a17b..3b11fa0919 100644 --- a/docs/linode-docs/providers/linode/instances/kernels/index.md +++ b/docs/linode-docs/providers/linode/instances/kernels/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekernels
TypeResource
Idlinode.instances.kernels
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of this Kernel. | -| `xen` | `boolean` | If this Kernel is suitable for Xen Linodes. | -| `built` | `string` | The date on which this Kernel was built. | -| `label` | `string` | The friendly name of this Kernel. | -| `deprecated` | `boolean` | If this Kernel is marked as deprecated, this field has a value of true; otherwise, this field is false. | -| `architecture` | `string` | The architecture of this Kernel. | -| `pvops` | `boolean` | If this Kernel is suitable for paravirtualized operations. | -| `version` | `string` | Linux Kernel version. | -| `kvm` | `boolean` | If this Kernel is suitable for KVM Linodes. | +| | `string` | The unique ID of this Kernel. | +| | `string` | The architecture of this Kernel. | +| | `string` | The date on which this Kernel was built. | +| | `boolean` | If this Kernel is marked as deprecated, this field has a value of true; otherwise, this field is false. | +| | `boolean` | If this Kernel is suitable for KVM Linodes. | +| | `string` | The friendly name of this Kernel. | +| | `boolean` | If this Kernel is suitable for paravirtualized operations. | +| | `string` | Linux Kernel version. | +| | `boolean` | If this Kernel is suitable for Xen Linodes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getKernel` | `SELECT` | `kernelId` | Returns information about a single Kernel.
| -| `getKernels` | `SELECT` | | Lists available Kernels.
| -| `_getKernel` | `EXEC` | `kernelId` | Returns information about a single Kernel.
| -| `_getKernels` | `EXEC` | | Lists available Kernels.
| +| | `SELECT` | | Returns information about a single Kernel.
| +| | `SELECT` | | Lists available Kernels.
| +| | `EXEC` | | Returns information about a single Kernel.
| +| | `EXEC` | | Lists available Kernels.
| diff --git a/docs/linode-docs/providers/linode/instances/linodes/index.md b/docs/linode-docs/providers/linode/instances/linodes/index.md index 84286acb0e..2be9777f4a 100644 --- a/docs/linode-docs/providers/linode/instances/linodes/index.md +++ b/docs/linode-docs/providers/linode/instances/linodes/index.md @@ -14,54 +14,57 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelinodes
TypeResource
Idlinode.instances.linodes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Linode's ID which must be provided for all operations impacting this Linode.
| -| `created` | `string` | When this Linode was created. | -| `host_uuid` | `string` | The Linode's host machine, as a UUID. | -| `region` | `string` | This is the [Region](/docs/api/regions/#regions-list) where the Linode was deployed. A Linode's region can only be changed by initiating a [cross data center migration](/docs/api/linode-instances/#dc-migrationpending-host-migration-initiate).
| -| `ipv4` | `array` | This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address
upon creation, and may get a single private IPv4 address if needed. You may need to
[open a support ticket](/docs/api/support/#support-ticket-open)
to get additional IPv4 addresses.

IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes.
See the [/networking](/docs/api/networking/) endpoints for details.
| -| `backups` | `object` | Information about this Linode's backups status. For information about available backups, see [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#backups-list).
| -| `label` | `string` | The Linode's label is for display purposes only. If no label is provided for a Linode,
a default will be assigned.

Linode labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
| -| `status` | `string` | A brief description of this Linode's current state. This field may change without direct action from you. For example, when a Linode goes into maintenance mode its status will display "stopped".
| -| `specs` | `object` | Information about the resources available to this Linode. | -| `updated` | `string` | When this Linode was last updated. | -| `ipv6` | `string` | This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.
| -| `watchdog_enabled` | `boolean` | The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible.
To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.
| -| `group` | `string` | A deprecated property denoting a group label for this Linode.
| -| `tags` | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| -| `type` | `string` | This is the [Linode Type](/docs/api/linode-types/#types-list) that this Linode was deployed with.
To change a Linode's Type, use [POST /linode/instances/{linodeId}/resize](/docs/api/linode-instances/#linode-resize).
| -| `image` | `string` | An Image ID to deploy the Linode Disk from.

Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view
all available Images. Official Linode Images start with `linode/`, while your Account's Images start with `private/`. Creating
a disk from a Private Image requires `read_only` or `read_write` permissions for that Image. Access the User's
Grant Update ([PUT /account/users/{username}/grants](/docs/api/account/#users-grants-update)) endpoint to
adjust permissions for an Account Image.
| -| `hypervisor` | `string` | The virtualization software powering this Linode.
| -| `alerts` | `object` | | +| | `integer` | This Linode's ID which must be provided for all operations impacting this Linode.
| +| | `object` | | +| | `object` | Information about this Linode's backups status. For information about available backups, see [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#backups-list).
| +| | `string` | When this Linode was created. | +| | `string` | A deprecated property denoting a group label for this Linode.
| +| | `string` | The Linode's host machine, as a UUID. | +| | `string` | The virtualization software powering this Linode.
| +| | `string` | An Image ID to deploy the Linode Disk from.

Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view
all available Images. Official Linode Images start with `linode/`, while your Account's Images start with `private/`. Creating
a disk from a Private Image requires `read_only` or `read_write` permissions for that Image. Access the User's
Grant Update ([PUT /account/users/{username}/grants](/docs/api/account/#users-grants-update)) endpoint to
adjust permissions for an Account Image.
| +| | `array` | This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address
upon creation, and may get a single private IPv4 address if needed. You may need to
[open a support ticket](/docs/api/support/#support-ticket-open)
to get additional IPv4 addresses.

IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes.
See the [/networking](/docs/api/networking/) endpoints for details.
| +| | `string` | This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.
| +| | `string` | The Linode's label is for display purposes only. If no label is provided for a Linode,
a default will be assigned.

Linode labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
| +| | `string` | This is the [Region](/docs/api/regions/#regions-list) where the Linode was deployed. A Linode's region can only be changed by initiating a [cross data center migration](/docs/api/linode-instances/#dc-migrationpending-host-migration-initiate).
| +| | `object` | Information about the resources available to this Linode. | +| | `string` | A brief description of this Linode's current state. This field may change without direct action from you. For example, when a Linode goes into maintenance mode its status will display "stopped".
| +| | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | This is the [Linode Type](/docs/api/linode-types/#types-list) that this Linode was deployed with.
To change a Linode's Type, use [POST /linode/instances/{linodeId}/resize](/docs/api/linode-instances/#linode-resize).
| +| | `string` | When this Linode was last updated. | +| | `boolean` | The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible.
To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeInstance` | `SELECT` | `linodeId` | Get a specific Linode by ID. | -| `getLinodeInstances` | `SELECT` | | Returns a paginated list of Linodes you have permission to view.
| -| `createLinodeInstance` | `INSERT` | `data__region, data__type` | Creates a Linode Instance on your Account. In order for this
request to complete successfully, your User must have the `add_linodes` grant. Creating a
new Linode will incur a charge on your Account.

Linodes can be created using one of the available Types. See
Types List ([GET /linode/types](/docs/api/linode-types/#types-list)) to get more
information about each Type's specs and cost.

Linodes can be created in any one of our available Regions, which are accessible from the
Regions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint.

In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587
on all Linodes for new accounts created after November 5th, 2019. For more information,
see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).

Linodes can be created in a number of ways:

* Using a Linode Public Image distribution or a Private Image you created based on another Linode.
* Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view
all available Images.
* The Linode will be `running` after it completes `provisioning`.
* A default config with two Disks, one being a 512 swap disk, is created.
* `swap_size` can be used to customize the swap disk size.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.

* Using a StackScript.
* See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for
a list of available StackScripts.
* The Linode will be `running` after it completes `provisioning`.
* Requires a compatible Image to be supplied.
* See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.

* Using one of your other Linode's backups.
* You must create a Linode large enough to accommodate the Backup's size.
* The Disks and Config will match that of the Linode that was backed up.
* The `root_pass` will match that of the Linode that was backed up.

* Attached to a private VLAN.
* Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.
* For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).

* Create an empty Linode.
* The Linode will remain `offline` and must be manually started.
* See Linode Boot ([POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#linode-boot)).
* Disks and Configs must be created manually.
* This is only recommended for advanced use cases.

**Important**: You must be an unrestricted User in order to add or modify
tags on Linodes.
| -| `deleteLinodeInstance` | `DELETE` | `linodeId` | Deletes a Linode you have permission to `read_write`.

**Deleting a Linode is a destructive action and cannot be undone.**

Additionally, deleting a Linode:

* Gives up any IP addresses the Linode was assigned.
* Deletes all Disks, Backups, Configs, etc.
* Stops billing for the Linode and its associated services. You will be billed for time used
within the billing period the Linode was active.

Linodes that are in the process of [cloning](/docs/api/linode-instances/#linode-clone) or [backup restoration](/docs/api/linode-instances/#backup-restore) cannot be deleted.
| -| `_getLinodeInstance` | `EXEC` | `linodeId` | Get a specific Linode by ID. | -| `_getLinodeInstances` | `EXEC` | | Returns a paginated list of Linodes you have permission to view.
| -| `bootLinodeInstance` | `EXEC` | `linodeId` | Boots a Linode you have permission to modify. If no parameters are given, a Config profile
will be chosen for this boot based on the following criteria:

* If there is only one Config profile for this Linode, it will be used.
* If there is more than one Config profile, the last booted config will be used.
* If there is more than one Config profile and none were the last to be booted (because the
Linode was never booted or the last booted config was deleted) an error will be returned.
| -| `cloneLinodeInstance` | `EXEC` | `linodeId` | You can clone your Linode's existing Disks or Configuration profiles to
another Linode on your Account. In order for this request to complete
successfully, your User must have the `add_linodes` grant. Cloning to a
new Linode will incur a charge on your Account.

If cloning to an existing Linode, any actions currently running or
queued must be completed first before you can clone to it.

Up to five clone operations from any given source Linode can be run concurrently.
If more concurrent clones are attempted, an HTTP 400 error will be
returned by this endpoint.

Any [tags](/docs/api/tags/#tags-list) existing on the source Linode will be cloned to the target Linode.
| -| `migrateLinodeInstance` | `EXEC` | `linodeId` | Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from [GET /account/notifications](/docs/api/account/#notifications-list). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed.

To initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from [GET /regions](/docs/api/regions/#regions-list). If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed.

**Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.
| -| `mutateLinodeInstance` | `EXEC` | `linodeId` | Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running.
If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate.
| -| `rebootLinodeInstance` | `EXEC` | `linodeId` | Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot.
| -| `rebuildLinodeInstance` | `EXEC` | `linodeId, data__image, data__root_pass` | Rebuilds a Linode you have the `read_write` permission to modify.
A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new `image` to the Linode with the given attributes. Additionally:

* Requires an `image` be supplied.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the
`authorized_keys` field.
| -| `rescueLinodeInstance` | `EXEC` | `linodeId` | Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP.
* Note that "sdh" is reserved and unavailable during rescue.
| -| `resetLinodePassword` | `EXEC` | `linodeId, data__root_pass` | Resets the root password for this Linode.
* Your Linode must be [shut down](/docs/api/linode-instances/#linode-shut-down) for a password reset to complete.
* If your Linode has more than one disk (not counting its swap disk), use the [Reset Disk Root Password](/docs/api/linode-instances/#disk-root-password-reset) endpoint to update a specific disk's root password.
* A `password_reset` event is generated when a root password reset is successful.
| -| `resizeLinodeInstance` | `EXEC` | `linodeId, data__type` | Resizes a Linode you have the `read_write` permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode:

* The Linode must not have a pending migration.
* Your Account cannot have an outstanding balance.
* The Linode must not have more disk allocation than the new Type allows.
* In that situation, you must first delete or resize the disk to be smaller.
| -| `shutdownLinodeInstance` | `EXEC` | `linodeId` | Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown.
| -| `updateLinodeInstance` | `EXEC` | `linodeId` | Updates a Linode that you have permission to `read_write`.

**Important**: You must be an unrestricted User in order to add or modify tags on Linodes.
| +| | `SELECT` | | Get a specific Linode by ID. | +| | `SELECT` | | Returns a paginated list of Linodes you have permission to view.
| +| | `INSERT` | | Creates a Linode Instance on your Account. In order for this
request to complete successfully, your User must have the `add_linodes` grant. Creating a
new Linode will incur a charge on your Account.

Linodes can be created using one of the available Types. See
Types List ([GET /linode/types](/docs/api/linode-types/#types-list)) to get more
information about each Type's specs and cost.

Linodes can be created in any one of our available Regions, which are accessible from the
Regions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint.

In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587
on all Linodes for new accounts created after November 5th, 2019. For more information,
see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).

Linodes can be created in a number of ways:

* Using a Linode Public Image distribution or a Private Image you created based on another Linode.
* Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view
all available Images.
* The Linode will be `running` after it completes `provisioning`.
* A default config with two Disks, one being a 512 swap disk, is created.
* `swap_size` can be used to customize the swap disk size.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.

* Using a StackScript.
* See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for
a list of available StackScripts.
* The Linode will be `running` after it completes `provisioning`.
* Requires a compatible Image to be supplied.
* See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the `authorized_keys` field.
* You may also supply a list of usernames via the `authorized_users` field.
* These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.

* Using one of your other Linode's backups.
* You must create a Linode large enough to accommodate the Backup's size.
* The Disks and Config will match that of the Linode that was backed up.
* The `root_pass` will match that of the Linode that was backed up.

* Attached to a private VLAN.
* Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.
* For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).

* Create an empty Linode.
* The Linode will remain `offline` and must be manually started.
* See Linode Boot ([POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#linode-boot)).
* Disks and Configs must be created manually.
* This is only recommended for advanced use cases.

**Important**: You must be an unrestricted User in order to add or modify
tags on Linodes.
| +| | `DELETE` | | Deletes a Linode you have permission to `read_write`.

**Deleting a Linode is a destructive action and cannot be undone.**

Additionally, deleting a Linode:

* Gives up any IP addresses the Linode was assigned.
* Deletes all Disks, Backups, Configs, etc.
* Stops billing for the Linode and its associated services. You will be billed for time used
within the billing period the Linode was active.

Linodes that are in the process of [cloning](/docs/api/linode-instances/#linode-clone) or [backup restoration](/docs/api/linode-instances/#backup-restore) cannot be deleted.
| +| | `EXEC` | | Get a specific Linode by ID. | +| | `EXEC` | | Returns a paginated list of Linodes you have permission to view.
| +| | `EXEC` | | Boots a Linode you have permission to modify. If no parameters are given, a Config profile
will be chosen for this boot based on the following criteria:

* If there is only one Config profile for this Linode, it will be used.
* If there is more than one Config profile, the last booted config will be used.
* If there is more than one Config profile and none were the last to be booted (because the
Linode was never booted or the last booted config was deleted) an error will be returned.
| +| | `EXEC` | | You can clone your Linode's existing Disks or Configuration profiles to
another Linode on your Account. In order for this request to complete
successfully, your User must have the `add_linodes` grant. Cloning to a
new Linode will incur a charge on your Account.

If cloning to an existing Linode, any actions currently running or
queued must be completed first before you can clone to it.

Up to five clone operations from any given source Linode can be run concurrently.
If more concurrent clones are attempted, an HTTP 400 error will be
returned by this endpoint.

Any [tags](/docs/api/tags/#tags-list) existing on the source Linode will be cloned to the target Linode.
| +| | `EXEC` | | Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from [GET /account/notifications](/docs/api/account/#notifications-list). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed.

To initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from [GET /regions](/docs/api/regions/#regions-list). If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed.

**Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.
| +| | `EXEC` | | Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running.
If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate.
| +| | `EXEC` | | Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot.
| +| | `EXEC` | | Rebuilds a Linode you have the `read_write` permission to modify.
A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new `image` to the Linode with the given attributes. Additionally:

* Requires an `image` be supplied.
* Requires a `root_pass` be supplied to use for the root User's Account.
* It is recommended to supply SSH keys for the root User using the
`authorized_keys` field.
| +| | `EXEC` | | Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP.
* Note that "sdh" is reserved and unavailable during rescue.
| +| | `EXEC` | | Resets the root password for this Linode.
* Your Linode must be [shut down](/docs/api/linode-instances/#linode-shut-down) for a password reset to complete.
* If your Linode has more than one disk (not counting its swap disk), use the [Reset Disk Root Password](/docs/api/linode-instances/#disk-root-password-reset) endpoint to update a specific disk's root password.
* A `password_reset` event is generated when a root password reset is successful.
| +| | `EXEC` | | Resizes a Linode you have the `read_write` permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode:

* The Linode must not have a pending migration.
* Your Account cannot have an outstanding balance.
* The Linode must not have more disk allocation than the new Type allows.
* In that situation, you must first delete or resize the disk to be smaller.
| +| | `EXEC` | | Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown.
| +| | `EXEC` | | Updates a Linode that you have permission to `read_write`.

**Important**: You must be an unrestricted User in order to add or modify tags on Linodes.
| diff --git a/docs/linode-docs/providers/linode/instances/nodebalancers/index.md b/docs/linode-docs/providers/linode/instances/nodebalancers/index.md index f660ff6225..902ddfc6a0 100644 --- a/docs/linode-docs/providers/linode/instances/nodebalancers/index.md +++ b/docs/linode-docs/providers/linode/instances/nodebalancers/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenodebalancers
TypeResource
Idlinode.instances.nodebalancers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This NodeBalancer's unique ID.
| -| `ipv4` | `string` | This NodeBalancer's public IPv4 address.
| -| `transfer` | `object` | Information about the amount of transfer this NodeBalancer has had so far this month.
| -| `ipv6` | `string` | This NodeBalancer's public IPv6 address.
| -| `label` | `string` | This NodeBalancer's label. These must be unique on your Account.
| -| `region` | `string` | The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
| -| `created` | `string` | When this NodeBalancer was created.
| -| `client_conn_throttle` | `integer` | Throttle connections per second. Set to 0 (zero) to disable throttling.
| -| `updated` | `string` | When this NodeBalancer was last updated.
| -| `hostname` | `string` | This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
| -| `tags` | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| +| | `integer` | This NodeBalancer's unique ID.
| +| | `integer` | Throttle connections per second. Set to 0 (zero) to disable throttling.
| +| | `string` | When this NodeBalancer was created.
| +| | `string` | This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
| +| | `string` | This NodeBalancer's public IPv4 address.
| +| | `string` | This NodeBalancer's public IPv6 address.
| +| | `string` | This NodeBalancer's label. These must be unique on your Account.
| +| | `string` | The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
| +| | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| +| | `object` | Information about the amount of transfer this NodeBalancer has had so far this month.
| +| | `string` | When this NodeBalancer was last updated.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLinodeNodeBalancers` | `SELECT` | `linodeId` | -| `_getLinodeNodeBalancers` | `EXEC` | `linodeId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/instances/stackscripts/index.md b/docs/linode-docs/providers/linode/instances/stackscripts/index.md index 941a4bc5b9..813362111c 100644 --- a/docs/linode-docs/providers/linode/instances/stackscripts/index.md +++ b/docs/linode-docs/providers/linode/instances/stackscripts/index.md @@ -14,41 +14,44 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestackscripts
TypeResource
Idlinode.instances.stackscripts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this StackScript. | -| `description` | `string` | A description for the StackScript.
| -| `deployments_active` | `integer` | Count of currently active, deployed Linodes created from this StackScript.
| -| `images` | `array` | An array of Image IDs. These are the Images that can be deployed with this StackScript.

`any/all` indicates that all available Images, including private Images, are accepted.
| -| `user_defined_fields` | `array` | This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs) for more information.
| -| `rev_note` | `string` | This field allows you to add notes for the set of revisions made to this StackScript.
| -| `username` | `string` | The User who created the StackScript.
| -| `is_public` | `boolean` | This determines whether other users can use your StackScript. **Once a StackScript is made public, it cannot be made private.**
| -| `script` | `string` | The script to execute when provisioning a new Linode with this StackScript.
| -| `deployments_total` | `integer` | The total number of times this StackScript has been deployed.
| -| `mine` | `boolean` | Returns `true` if this StackScript is owned by the account of the user making the request, and the user
making the request is unrestricted or has access to this StackScript.
| -| `updated` | `string` | The date this StackScript was last updated.
| -| `created` | `string` | The date this StackScript was created.
| -| `label` | `string` | The StackScript's label is for display purposes only.
| -| `user_gravatar_id` | `string` | The Gravatar ID for the User who created the StackScript.
| +| | `integer` | The unique ID of this StackScript. | +| | `string` | A description for the StackScript.
| +| | `string` | The date this StackScript was created.
| +| | `integer` | Count of currently active, deployed Linodes created from this StackScript.
| +| | `integer` | The total number of times this StackScript has been deployed.
| +| | `array` | An array of Image IDs. These are the Images that can be deployed with this StackScript.

`any/all` indicates that all available Images, including private Images, are accepted.
| +| | `boolean` | This determines whether other users can use your StackScript. **Once a StackScript is made public, it cannot be made private.**
| +| | `string` | The StackScript's label is for display purposes only.
| +| | `boolean` | Returns `true` if this StackScript is owned by the account of the user making the request, and the user
making the request is unrestricted or has access to this StackScript.
| +| | `string` | This field allows you to add notes for the set of revisions made to this StackScript.
| +| | `string` | The script to execute when provisioning a new Linode with this StackScript.
| +| | `string` | The date this StackScript was last updated.
| +| | `array` | This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs) for more information.
| +| | `string` | The Gravatar ID for the User who created the StackScript.
| +| | `string` | The User who created the StackScript.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getStackScript` | `SELECT` | `stackscriptId` | Returns all of the information about a specified StackScript, including the contents of the script.
| -| `getStackScripts` | `SELECT` | | If the request is not authenticated, only public StackScripts are returned.

For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
| -| `addStackScript` | `INSERT` | `data__images, data__label, data__script` | Creates a StackScript in your Account.
| -| `deleteStackScript` | `DELETE` | `stackscriptId` | Deletes a private StackScript you have permission to `read_write`. You cannot delete a public StackScript.
| -| `_getStackScript` | `EXEC` | `stackscriptId` | Returns all of the information about a specified StackScript, including the contents of the script.
| -| `_getStackScripts` | `EXEC` | | If the request is not authenticated, only public StackScripts are returned.

For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
| -| `updateStackScript` | `EXEC` | `stackscriptId` | Updates a StackScript.

**Once a StackScript is made public, it cannot be made private.**
| +| | `SELECT` | | Returns all of the information about a specified StackScript, including the contents of the script.
| +| | `SELECT` | | If the request is not authenticated, only public StackScripts are returned.

For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
| +| | `INSERT` | | Creates a StackScript in your Account.
| +| | `DELETE` | | Deletes a private StackScript you have permission to `read_write`. You cannot delete a public StackScript.
| +| | `EXEC` | | Returns all of the information about a specified StackScript, including the contents of the script.
| +| | `EXEC` | | If the request is not authenticated, only public StackScripts are returned.

For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
| +| | `EXEC` | | Updates a StackScript.

**Once a StackScript is made public, it cannot be made private.**
| diff --git a/docs/linode-docs/providers/linode/instances/stats/index.md b/docs/linode-docs/providers/linode/instances/stats/index.md index 87e59c339a..f80746b7e6 100644 --- a/docs/linode-docs/providers/linode/instances/stats/index.md +++ b/docs/linode-docs/providers/linode/instances/stats/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestats
TypeResource
Idlinode.instances.stats
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `netv4` | `object` | IPv4 statistics. | -| `netv6` | `object` | IPv6 statistics. | -| `title` | `string` | The title for this data set. | -| `cpu` | `array` | Percentage of CPU used.
| -| `io` | `object` | Input/Output statistics. | +| | `array` | Percentage of CPU used.
| +| | `object` | Input/Output statistics. | +| | `object` | IPv4 statistics. | +| | `object` | IPv6 statistics. | +| | `string` | The title for this data set. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeStats` | `SELECT` | `linodeId` | Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.
| -| `getLinodeStatsByYearMonth` | `SELECT` | `linodeId, month, year` | Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days.
| -| `_getLinodeStats` | `EXEC` | `linodeId` | Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.
| -| `_getLinodeStatsByYearMonth` | `EXEC` | `linodeId, month, year` | Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days.
| +| | `SELECT` | | Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.
| +| | `SELECT` | | Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days.
| +| | `EXEC` | | Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.
| +| | `EXEC` | | Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days.
| diff --git a/docs/linode-docs/providers/linode/instances/transfer/index.md b/docs/linode-docs/providers/linode/instances/transfer/index.md index 240dba94b9..5ed2ecf99f 100644 --- a/docs/linode-docs/providers/linode/instances/transfer/index.md +++ b/docs/linode-docs/providers/linode/instances/transfer/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametransfer
TypeResource
Idlinode.instances.transfer
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `quota` | `integer` | The amount of network transfer this Linode adds to your transfer pool, in GB, for the current month's billing cycle.
| -| `used` | `integer` | The amount of network transfer used by this Linode, in bytes, for the current month's billing cycle.
| -| `billable` | `integer` | The amount of network transfer this Linode has used, in GB, past your monthly quota.
| +| | `integer` | The amount of network transfer this Linode has used, in GB, past your monthly quota.
| +| | `integer` | The amount of network transfer this Linode adds to your transfer pool, in GB, for the current month's billing cycle.
| +| | `integer` | The amount of network transfer used by this Linode, in bytes, for the current month's billing cycle.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeTransfer` | `SELECT` | `linodeId` | Returns a Linode's network transfer pool statistics for the current month.
| -| `getLinodeTransferByYearMonth` | `SELECT` | `linodeId, month, year` | Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month.
| -| `_getLinodeTransfer` | `EXEC` | `linodeId` | Returns a Linode's network transfer pool statistics for the current month.
| -| `_getLinodeTransferByYearMonth` | `EXEC` | `linodeId, month, year` | Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month.
| +| | `SELECT` | | Returns a Linode's network transfer pool statistics for the current month.
| +| | `SELECT` | | Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month.
| +| | `EXEC` | | Returns a Linode's network transfer pool statistics for the current month.
| +| | `EXEC` | | Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month.
| diff --git a/docs/linode-docs/providers/linode/instances/types/index.md b/docs/linode-docs/providers/linode/instances/types/index.md index b0fb7599f8..516d804b9a 100644 --- a/docs/linode-docs/providers/linode/instances/types/index.md +++ b/docs/linode-docs/providers/linode/instances/types/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametypes
TypeResource
Idlinode.instances.types
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID representing the Linode Type. | -| `network_out` | `integer` | The Mbits outbound bandwidth allocation.
| -| `disk` | `integer` | The Disk size, in MB, of the Linode Type.
| -| `transfer` | `integer` | The monthly outbound transfer amount, in MB.
| -| `addons` | `object` | A list of optional add-on services for Linodes and their associated costs.
| -| `successor` | `string` | The Linode Type that a [mutate](/docs/api/linode-instances/#linode-upgrade) will upgrade to for a Linode of this type. If "null", a Linode of this type may not mutate.
| -| `gpus` | `integer` | The number of GPUs this Linode Type offers.
| -| `memory` | `integer` | Amount of RAM included in this Linode Type.
| -| `label` | `string` | The Linode Type's label is for display purposes only.
| -| `class` | `string` | The class of the Linode Type. We currently offer five classes of Linodes:

* nanode - Nanode instances are good for low-duty workloads,
where performance isn't critical. **Note:** As of June 16th, 2020, Nanodes became
1 GB Linodes in the Cloud Manager, however, the API, the CLI, and billing will
continue to refer to these instances as Nanodes.
* standard - Standard Shared instances are good for medium-duty workloads and
are a good mix of performance, resources, and price. **Note:** As of June 16th, 2020,
Standard Linodes in the Cloud Manager became Shared Linodes, however, the API, the CLI, and
billing will continue to refer to these instances as Standard Linodes.
* dedicated - Dedicated CPU instances are good for full-duty workloads
where consistent performance is important.
* gpu - Linodes with dedicated NVIDIA Quadro ® RTX 6000 GPUs accelerate highly
specialized applications such as machine learning, AI, and video transcoding.
* highmem - High Memory instances favor RAM over other resources, and can be
good for memory hungry use cases like caching and in-memory databases.
All High Memory plans contain dedicated CPU cores.
| -| `vcpus` | `integer` | The number of VCPU cores this Linode Type offers.
| -| `price` | `object` | Cost in US dollars, broken down into hourly and monthly charges.
| +| | `string` | The ID representing the Linode Type. | +| | `object` | A list of optional add-on services for Linodes and their associated costs.
| +| | `string` | The class of the Linode Type. We currently offer five classes of Linodes:

* nanode - Nanode instances are good for low-duty workloads,
where performance isn't critical. **Note:** As of June 16th, 2020, Nanodes became
1 GB Linodes in the Cloud Manager, however, the API, the CLI, and billing will
continue to refer to these instances as Nanodes.
* standard - Standard Shared instances are good for medium-duty workloads and
are a good mix of performance, resources, and price. **Note:** As of June 16th, 2020,
Standard Linodes in the Cloud Manager became Shared Linodes, however, the API, the CLI, and
billing will continue to refer to these instances as Standard Linodes.
* dedicated - Dedicated CPU instances are good for full-duty workloads
where consistent performance is important.
* gpu - Linodes with dedicated NVIDIA Quadro ® RTX 6000 GPUs accelerate highly
specialized applications such as machine learning, AI, and video transcoding.
* highmem - High Memory instances favor RAM over other resources, and can be
good for memory hungry use cases like caching and in-memory databases.
All High Memory plans contain dedicated CPU cores.
| +| | `integer` | The Disk size, in MB, of the Linode Type.
| +| | `integer` | The number of GPUs this Linode Type offers.
| +| | `string` | The Linode Type's label is for display purposes only.
| +| | `integer` | Amount of RAM included in this Linode Type.
| +| | `integer` | The Mbits outbound bandwidth allocation.
| +| | `object` | Cost in US dollars, broken down into hourly and monthly charges.
| +| | `string` | The Linode Type that a [mutate](/docs/api/linode-instances/#linode-upgrade) will upgrade to for a Linode of this type. If "null", a Linode of this type may not mutate.
| +| | `integer` | The monthly outbound transfer amount, in MB.
| +| | `integer` | The number of VCPU cores this Linode Type offers.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLinodeType` | `SELECT` | `typeId` | Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| -| `getLinodeTypes` | `SELECT` | | Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| -| `_getLinodeType` | `EXEC` | `typeId` | Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| -| `_getLinodeTypes` | `EXEC` | | Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| +| | `SELECT` | | Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| +| | `SELECT` | | Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| +| | `EXEC` | | Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| +| | `EXEC` | | Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.
| diff --git a/docs/linode-docs/providers/linode/instances/volumes/index.md b/docs/linode-docs/providers/linode/instances/volumes/index.md index 6ff4e76d4e..0281c2b61e 100644 --- a/docs/linode-docs/providers/linode/instances/volumes/index.md +++ b/docs/linode-docs/providers/linode/instances/volumes/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolumes
TypeResource
Idlinode.instances.volumes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this Volume. | -| `hardware_type` | `string` | The storage type of this Volume. | -| `updated` | `string` | When this Volume was last updated. | -| `tags` | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| -| `status` | `string` | The current status of the volume. Can be one of:

* `creating` - the Volume is being created and is not yet available
for use.
* `active` - the Volume is online and available for use.
* `resizing` - the Volume is in the process of upgrading
its current capacity.
| -| `created` | `string` | When this Volume was created. | -| `label` | `string` | The Volume's label is for display purposes only.
| -| `linode_id` | `integer` | If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
| -| `filesystem_path` | `string` | The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.
| -| `size` | `integer` | The Volume's size, in GiB.
| -| `linode_label` | `string` | If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
| -| `region` | `string` | The unique ID of this Region. | +| | `integer` | The unique ID of this Volume. | +| | `string` | When this Volume was created. | +| | `string` | The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.
| +| | `string` | The storage type of this Volume. | +| | `string` | The Volume's label is for display purposes only.
| +| | `integer` | If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
| +| | `string` | If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
| +| | `string` | The unique ID of this Region. | +| | `integer` | The Volume's size, in GiB.
| +| | `string` | The current status of the volume. Can be one of:

* `creating` - the Volume is being created and is not yet available
for use.
* `active` - the Volume is online and available for use.
* `resizing` - the Volume is in the process of upgrading
its current capacity.
| +| | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | When this Volume was last updated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLinodeVolumes` | `SELECT` | `linodeId` | -| `_getLinodeVolumes` | `EXEC` | `linodeId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/lke/clusters/index.md b/docs/linode-docs/providers/linode/lke/clusters/index.md index 73b2ca4134..fd8617f253 100644 --- a/docs/linode-docs/providers/linode/lke/clusters/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters
TypeResource
Idlinode.lke.clusters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Kubernetes cluster's unique ID. | -| `created` | `string` | When this Kubernetes cluster was created. | -| `k8s_version` | `string` | The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed.
| -| `label` | `string` | This Kubernetes cluster's unique label for display purposes only.
Labels have the following constraints:

* UTF-8 characters will be returned by the API using escape
sequences of their Unicode code points. For example, the
Japanese character *か* is 3 bytes in UTF-8 (`0xE382AB`). Its
Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this
character and the API will return it as the escape sequence
using six 1 byte characters which represent 2 bytes of Unicode
code point (`"\u30ab"`).
* 4 byte UTF-8 characters are not supported.
* If the label is entirely composed of UTF-8 characters, the API
response will return the code points using up to 193 1 byte
characters.
| -| `region` | `string` | This Kubernetes cluster's location. | -| `tags` | `array` | An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
| -| `updated` | `string` | When this Kubernetes cluster was updated. | -| `control_plane` | `object` | Defines settings for the Kubernetes Control Plane. Allows for the enabling of High Availability (HA) for Control Plane Components. Enabling High Avaialability for LKE is an **irreversible** change.
| +| | `integer` | This Kubernetes cluster's unique ID. | +| | `object` | Defines settings for the Kubernetes Control Plane. Allows for the enabling of High Availability (HA) for Control Plane Components. Enabling High Avaialability for LKE is an **irreversible** change.
| +| | `string` | When this Kubernetes cluster was created. | +| | `string` | The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed.
| +| | `string` | This Kubernetes cluster's unique label for display purposes only.
Labels have the following constraints:

* UTF-8 characters will be returned by the API using escape
sequences of their Unicode code points. For example, the
Japanese character *か* is 3 bytes in UTF-8 (`0xE382AB`). Its
Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this
character and the API will return it as the escape sequence
using six 1 byte characters which represent 2 bytes of Unicode
code point (`"\u30ab"`).
* 4 byte UTF-8 characters are not supported.
* If the label is entirely composed of UTF-8 characters, the API
response will return the code points using up to 193 1 byte
characters.
| +| | `string` | This Kubernetes cluster's location. | +| | `array` | An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
| +| | `string` | When this Kubernetes cluster was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLKECluster` | `SELECT` | `clusterId` | Get a specific Cluster by ID.
| -| `getLKEClusters` | `SELECT` | | Lists current Kubernetes clusters available on your account.
| -| `createLKECluster` | `INSERT` | `data__k8s_version, data__label, data__node_pools, data__region` | Creates a Kubernetes cluster. The Kubernetes cluster will be created
asynchronously. You can use the events system to determine when the
Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the
[Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#kubernetes-api-endpoints-list) and
the [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#kubeconfig-view) for the new cluster
are ready.
| -| `deleteLKECluster` | `DELETE` | `clusterId` | Deletes a Cluster you have permission to `read_write`.

**Deleting a Cluster is a destructive action and cannot be undone.**

Deleting a Cluster:
- Deletes all Linodes in all pools within this Kubernetes cluster
- Deletes all supporting Kubernetes services for this Kubernetes
cluster (API server, etcd, etc)
- Deletes all NodeBalancers created by this Kubernetes cluster
- Does not delete any of the volumes created by this Kubernetes
cluster
| -| `_getLKECluster` | `EXEC` | `clusterId` | Get a specific Cluster by ID.
| -| `_getLKEClusters` | `EXEC` | | Lists current Kubernetes clusters available on your account.
| -| `postLKECServiceTokenDelete` | `EXEC` | `clusterId` | Delete and regenerate the service account token for a Cluster.

**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.
| -| `postLKEClusterRecycle` | `EXEC` | `clusterId` | Recycles all nodes in all pools of a designated Kubernetes Cluster. All Linodes within the Cluster will be deleted
and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are
installed with the latest available [patch version](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#kubernetes-release-versioning) for the Cluster's current Kubernetes minor release.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| -| `postLKEClusterRegenerate` | `EXEC` | `clusterId` | Regenerate the Kubeconfig file and/or the service account token for a Cluster.

This is a helper command that allows performing both the [Kubeconfig Delete](#kubeconfig-delete) and the [Service Token Delete](#service-token-delete) actions with a single request.

When using this command, at least one of `kubeconfig` or `servicetoken` is required.

**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.
| -| `putLKECluster` | `EXEC` | `clusterId` | Updates a Kubernetes cluster.
| +| | `SELECT` | | Get a specific Cluster by ID.
| +| | `SELECT` | | Lists current Kubernetes clusters available on your account.
| +| | `INSERT` | | Creates a Kubernetes cluster. The Kubernetes cluster will be created
asynchronously. You can use the events system to determine when the
Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the
[Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#kubernetes-api-endpoints-list) and
the [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#kubeconfig-view) for the new cluster
are ready.
| +| | `DELETE` | | Deletes a Cluster you have permission to `read_write`.

**Deleting a Cluster is a destructive action and cannot be undone.**

Deleting a Cluster:
- Deletes all Linodes in all pools within this Kubernetes cluster
- Deletes all supporting Kubernetes services for this Kubernetes
cluster (API server, etcd, etc)
- Deletes all NodeBalancers created by this Kubernetes cluster
- Does not delete any of the volumes created by this Kubernetes
cluster
| +| | `EXEC` | | Get a specific Cluster by ID.
| +| | `EXEC` | | Lists current Kubernetes clusters available on your account.
| +| | `EXEC` | | Delete and regenerate the service account token for a Cluster.

**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.
| +| | `EXEC` | | Recycles all nodes in all pools of a designated Kubernetes Cluster. All Linodes within the Cluster will be deleted
and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are
installed with the latest available [patch version](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#kubernetes-release-versioning) for the Cluster's current Kubernetes minor release.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| +| | `EXEC` | | Regenerate the Kubeconfig file and/or the service account token for a Cluster.

This is a helper command that allows performing both the [Kubeconfig Delete](#kubeconfig-delete) and the [Service Token Delete](#service-token-delete) actions with a single request.

When using this command, at least one of `kubeconfig` or `servicetoken` is required.

**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.
| +| | `EXEC` | | Updates a Kubernetes cluster.
| diff --git a/docs/linode-docs/providers/linode/lke/clusters_api_endpoints/index.md b/docs/linode-docs/providers/linode/lke/clusters_api_endpoints/index.md index 36101698a8..ff7b2b9b15 100644 --- a/docs/linode-docs/providers/linode/lke/clusters_api_endpoints/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters_api_endpoints/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters_api_endpoints
TypeResource
Idlinode.lke.clusters_api_endpoints
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLKEClusterAPIEndpoints` | `SELECT` | `clusterId` | -| `_getLKEClusterAPIEndpoints` | `EXEC` | `clusterId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/lke/clusters_dashboard/index.md b/docs/linode-docs/providers/linode/lke/clusters_dashboard/index.md index c136c726cc..4a31ad19ce 100644 --- a/docs/linode-docs/providers/linode/lke/clusters_dashboard/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters_dashboard/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters_dashboard
TypeResource
Idlinode.lke.clusters_dashboard
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLKEClusterDashboard` | `SELECT` | `clusterId` | -| `_getLKEClusterDashboard` | `EXEC` | `clusterId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/lke/clusters_kubeconfig/index.md b/docs/linode-docs/providers/linode/lke/clusters_kubeconfig/index.md index 24aa47521a..473e3bc015 100644 --- a/docs/linode-docs/providers/linode/lke/clusters_kubeconfig/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters_kubeconfig/index.md @@ -14,20 +14,23 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters_kubeconfig
TypeResource
Idlinode.lke.clusters_kubeconfig
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLKEClusterKubeconfig` | `SELECT` | `clusterId` | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before
the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).
| -| `deleteLKEClusterKubeconfig` | `DELETE` | `clusterId` | Delete and regenerate the Kubeconfig file for a Cluster.
| -| `_getLKEClusterKubeconfig` | `EXEC` | `clusterId` | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before
the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).
| +| | `SELECT` | | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before
the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).
| +| | `DELETE` | | Delete and regenerate the Kubeconfig file for a Cluster.
| +| | `EXEC` | | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before
the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).
| diff --git a/docs/linode-docs/providers/linode/lke/clusters_nodes/index.md b/docs/linode-docs/providers/linode/lke/clusters_nodes/index.md index 846e433984..d51260918f 100644 --- a/docs/linode-docs/providers/linode/lke/clusters_nodes/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters_nodes/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters_nodes
TypeResource
Idlinode.lke.clusters_nodes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The Node's ID.
| -| `instance_id` | `integer` | The Linode's ID. If no Linode is currently provisioned for this Node, this is `null`.
| -| `status` | `string` | The creation status of this Node. This status is distinct from this Node's readiness as a Kubernetes Node Object as determined by the command `kubectl get nodes`.

`not_ready` indicates that the Linode is still being created.

`ready` indicates that the Linode has successfully been created and is running Kubernetes software.
| +| | `string` | The Node's ID.
| +| | `integer` | The Linode's ID. If no Linode is currently provisioned for this Node, this is `null`.
| +| | `string` | The creation status of this Node. This status is distinct from this Node's readiness as a Kubernetes Node Object as determined by the command `kubectl get nodes`.

`not_ready` indicates that the Linode is still being created.

`ready` indicates that the Linode has successfully been created and is running Kubernetes software.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLKEClusterNode` | `SELECT` | `clusterId, nodeId` | Returns the values for a specified node object.
| -| `deleteLKEClusterNode` | `DELETE` | `clusterId, nodeId` | Deletes a specific Node from a Node Pool.

**Deleting a Node is a destructive action and cannot be undone.**

Deleting a Node will reduce the size of the Node Pool it belongs to.
| -| `_getLKEClusterNode` | `EXEC` | `clusterId, nodeId` | Returns the values for a specified node object.
| -| `postLKEClusterNodeRecycle` | `EXEC` | `clusterId, nodeId` | Recycles an individual Node in the designated Kubernetes Cluster. The Node will be deleted
and replaced with a new Linode, which may take a few minutes. Replacement Nodes are
installed with the latest available patch for the Cluster's Kubernetes Version.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| +| | `SELECT` | | Returns the values for a specified node object.
| +| | `DELETE` | | Deletes a specific Node from a Node Pool.

**Deleting a Node is a destructive action and cannot be undone.**

Deleting a Node will reduce the size of the Node Pool it belongs to.
| +| | `EXEC` | | Returns the values for a specified node object.
| +| | `EXEC` | | Recycles an individual Node in the designated Kubernetes Cluster. The Node will be deleted
and replaced with a new Linode, which may take a few minutes. Replacement Nodes are
installed with the latest available patch for the Cluster's Kubernetes Version.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| diff --git a/docs/linode-docs/providers/linode/lke/clusters_pools/index.md b/docs/linode-docs/providers/linode/lke/clusters_pools/index.md index 7d8c2f3149..e8498c9fed 100644 --- a/docs/linode-docs/providers/linode/lke/clusters_pools/index.md +++ b/docs/linode-docs/providers/linode/lke/clusters_pools/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters_pools
TypeResource
Idlinode.lke.clusters_pools
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Node Pool's unique ID.
| -| `nodes` | `array` | Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.
| -| `tags` | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| -| `type` | `string` | The Linode Type for all of the nodes in the Node Pool. | -| `autoscaler` | `object` | When enabled, the number of nodes autoscales within the defined minimum and maximum values.
| -| `count` | `integer` | The number of nodes in the Node Pool. | -| `disks` | `array` | This Node Pool's custom disk layout.
| +| | `integer` | This Node Pool's unique ID.
| +| | `object` | When enabled, the number of nodes autoscales within the defined minimum and maximum values.
| +| | `integer` | The number of nodes in the Node Pool. | +| | `array` | This Node Pool's custom disk layout.
| +| | `array` | Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.
| +| | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | The Linode Type for all of the nodes in the Node Pool. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLKEClusterPools` | `SELECT` | `clusterId` | Returns all active Node Pools on a Kubernetes cluster.
| -| `getLKENodePool` | `SELECT` | `clusterId, poolId` | Get a specific Node Pool by ID.
| -| `deleteLKENodePool` | `DELETE` | `clusterId, poolId` | Delete a specific Node Pool from a Kubernetes cluster.

**Deleting a Node Pool is a destructive action and cannot be undone.**

Deleting a Node Pool will delete all Linodes within that Pool.
| -| `_getLKEClusterPools` | `EXEC` | `clusterId` | Returns all active Node Pools on a Kubernetes cluster.
| -| `_getLKENodePool` | `EXEC` | `clusterId, poolId` | Get a specific Node Pool by ID.
| -| `postLKEClusterPoolRecycle` | `EXEC` | `clusterId, poolId` | Recycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted
and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are
installed with the latest available patch for the Cluster's Kubernetes Version.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| -| `postLKEClusterPools` | `EXEC` | `clusterId, data__count, data__type` | Creates a new Node Pool for the designated Kubernetes cluster.
| -| `putLKENodePool` | `EXEC` | `clusterId, poolId` | Updates a Node Pool's count and autoscaler configuration.

Linodes will be created or deleted to match changes to the Node Pool's count.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| +| | `SELECT` | | Returns all active Node Pools on a Kubernetes cluster.
| +| | `SELECT` | | Get a specific Node Pool by ID.
| +| | `DELETE` | | Delete a specific Node Pool from a Kubernetes cluster.

**Deleting a Node Pool is a destructive action and cannot be undone.**

Deleting a Node Pool will delete all Linodes within that Pool.
| +| | `EXEC` | | Returns all active Node Pools on a Kubernetes cluster.
| +| | `EXEC` | | Get a specific Node Pool by ID.
| +| | `EXEC` | | Recycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted
and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are
installed with the latest available patch for the Cluster's Kubernetes Version.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| +| | `EXEC` | | Creates a new Node Pool for the designated Kubernetes cluster.
| +| | `EXEC` | | Updates a Node Pool's count and autoscaler configuration.

Linodes will be created or deleted to match changes to the Node Pool's count.

**Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.**
| diff --git a/docs/linode-docs/providers/linode/lke/index.md b/docs/linode-docs/providers/linode/lke/index.md index 49c9d98515..61d45dc921 100644 --- a/docs/linode-docs/providers/linode/lke/index.md +++ b/docs/linode-docs/providers/linode/lke/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Lke :::info Service Summary diff --git a/docs/linode-docs/providers/linode/lke/versions/index.md b/docs/linode-docs/providers/linode/lke/versions/index.md index 0a63a594e8..7e1f89367a 100644 --- a/docs/linode-docs/providers/linode/lke/versions/index.md +++ b/docs/linode-docs/providers/linode/lke/versions/index.md @@ -14,21 +14,24 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameversions
TypeResource
Idlinode.lke.versions
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLKEVersion` | `SELECT` | `version` | View a Kubernetes version available for deployment to a Kubernetes cluster.
| -| `getLKEVersions` | `SELECT` | | List the Kubernetes versions available for deployment to a Kubernetes cluster.
| -| `_getLKEVersion` | `EXEC` | `version` | View a Kubernetes version available for deployment to a Kubernetes cluster.
| -| `_getLKEVersions` | `EXEC` | | List the Kubernetes versions available for deployment to a Kubernetes cluster.
| +| | `SELECT` | | View a Kubernetes version available for deployment to a Kubernetes cluster.
| +| | `SELECT` | | List the Kubernetes versions available for deployment to a Kubernetes cluster.
| +| | `EXEC` | | View a Kubernetes version available for deployment to a Kubernetes cluster.
| +| | `EXEC` | | List the Kubernetes versions available for deployment to a Kubernetes cluster.
| diff --git a/docs/linode-docs/providers/linode/longview/clients/index.md b/docs/linode-docs/providers/linode/longview/clients/index.md index 05580a95a5..20b6d92846 100644 --- a/docs/linode-docs/providers/linode/longview/clients/index.md +++ b/docs/linode-docs/providers/linode/longview/clients/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclients
TypeResource
Idlinode.longview.clients
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Client's unique ID.
| -| `created` | `string` | When this Longview Client was created.
| -| `install_code` | `string` | The install code for this Client, used when configuring the Longview
Client application on your Linode.

Returns as `[REDACTED]` if you do not have read-write access to this client.
| -| `label` | `string` | This Client's unique label. This is for display purposes only.
| -| `updated` | `string` | When this Longview Client was last updated.
| -| `api_key` | `string` | The API key for this Client, used when configuring the Longview
Client application on your Linode.

Returns as `[REDACTED]` if you do not have read-write access to this client.
| -| `apps` | `object` | The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
| +| | `integer` | This Client's unique ID.
| +| | `string` | The API key for this Client, used when configuring the Longview
Client application on your Linode.

Returns as `[REDACTED]` if you do not have read-write access to this client.
| +| | `object` | The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
| +| | `string` | When this Longview Client was created.
| +| | `string` | The install code for this Client, used when configuring the Longview
Client application on your Linode.

Returns as `[REDACTED]` if you do not have read-write access to this client.
| +| | `string` | This Client's unique label. This is for display purposes only.
| +| | `string` | When this Longview Client was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLongviewClient` | `SELECT` | `clientId` | Returns a single Longview Client you can access.
| -| `getLongviewClients` | `SELECT` | | Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.
| -| `createLongviewClient` | `INSERT` | | Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning `install_code` and `api_key`.
| -| `deleteLongviewClient` | `DELETE` | `clientId` | Deletes a Longview Client from your Account.

**All information stored for this client will be lost.**

This _does not_ uninstall the Longview Client application for your Linode - you must do that manually.
| -| `_getLongviewClient` | `EXEC` | `clientId` | Returns a single Longview Client you can access.
| -| `_getLongviewClients` | `EXEC` | | Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.
| -| `updateLongviewClient` | `EXEC` | `clientId` | Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.
| +| | `SELECT` | | Returns a single Longview Client you can access.
| +| | `SELECT` | | Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.
| +| | `INSERT` | | Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning `install_code` and `api_key`.
| +| | `DELETE` | | Deletes a Longview Client from your Account.

**All information stored for this client will be lost.**

This _does not_ uninstall the Longview Client application for your Linode - you must do that manually.
| +| | `EXEC` | | Returns a single Longview Client you can access.
| +| | `EXEC` | | Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.
| +| | `EXEC` | | Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.
| diff --git a/docs/linode-docs/providers/linode/longview/index.md b/docs/linode-docs/providers/linode/longview/index.md index 6804efb82a..316792f859 100644 --- a/docs/linode-docs/providers/linode/longview/index.md +++ b/docs/linode-docs/providers/linode/longview/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Longview :::info Service Summary diff --git a/docs/linode-docs/providers/linode/longview/plan/index.md b/docs/linode-docs/providers/linode/longview/plan/index.md index d1fae38fd6..be407de270 100644 --- a/docs/linode-docs/providers/linode/longview/plan/index.md +++ b/docs/linode-docs/providers/linode/longview/plan/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameplan
TypeResource
Idlinode.longview.plan
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of this Subscription tier.
| -| `clients_included` | `integer` | The number of Longview Clients that may be created with this Subscription tier.
| -| `label` | `string` | A display name for this Subscription tier.
| -| `price` | `object` | Pricing information about this Subscription tier.
| +| | `string` | The unique ID of this Subscription tier.
| +| | `integer` | The number of Longview Clients that may be created with this Subscription tier.
| +| | `string` | A display name for this Subscription tier.
| +| | `object` | Pricing information about this Subscription tier.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLongviewPlan` | `SELECT` | | Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free.

You must have at least one of the following `global` [User Grants](/docs/api/account/#users-grants-view) in order to access this endpoint:

- `"account_access": read_write`
- `"account_access": read_only`
- `"longview_subscription": true`
- `"add_longview": true`


To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| -| `_getLongviewPlan` | `EXEC` | | Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free.

You must have at least one of the following `global` [User Grants](/docs/api/account/#users-grants-view) in order to access this endpoint:

- `"account_access": read_write`
- `"account_access": read_only`
- `"longview_subscription": true`
- `"add_longview": true`


To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| -| `updateLongviewPlan` | `EXEC` | | Update your Longview plan to that of the given subcription ID. This returns a `LongviewSubscription` object for the updated Longview Pro plan, or an empty set `{}` if the updated plan is Longview Free.

You must have `"longview_subscription": true` configured as a `global` [User Grant](/docs/api/account/#users-grants-view) in order to access this endpoint.

You can send a request to the [List Longview Subscriptions](/docs/api/longview/#longview-subscriptions-list) endpoint to receive the details, including `id`'s, of each plan.
| +| | `SELECT` | | Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free.

You must have at least one of the following `global` [User Grants](/docs/api/account/#users-grants-view) in order to access this endpoint:

- `"account_access": read_write`
- `"account_access": read_only`
- `"longview_subscription": true`
- `"add_longview": true`


To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| +| | `EXEC` | | Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free.

You must have at least one of the following `global` [User Grants](/docs/api/account/#users-grants-view) in order to access this endpoint:

- `"account_access": read_write`
- `"account_access": read_only`
- `"longview_subscription": true`
- `"add_longview": true`


To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).
| +| | `EXEC` | | Update your Longview plan to that of the given subcription ID. This returns a `LongviewSubscription` object for the updated Longview Pro plan, or an empty set `{}` if the updated plan is Longview Free.

You must have `"longview_subscription": true` configured as a `global` [User Grant](/docs/api/account/#users-grants-view) in order to access this endpoint.

You can send a request to the [List Longview Subscriptions](/docs/api/longview/#longview-subscriptions-list) endpoint to receive the details, including `id`'s, of each plan.
| diff --git a/docs/linode-docs/providers/linode/longview/subscriptions/index.md b/docs/linode-docs/providers/linode/longview/subscriptions/index.md index 7e0afb0b58..2803cd3e13 100644 --- a/docs/linode-docs/providers/linode/longview/subscriptions/index.md +++ b/docs/linode-docs/providers/linode/longview/subscriptions/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubscriptions
TypeResource
Idlinode.longview.subscriptions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of this Subscription tier.
| -| `clients_included` | `integer` | The number of Longview Clients that may be created with this Subscription tier.
| -| `label` | `string` | A display name for this Subscription tier.
| -| `price` | `object` | Pricing information about this Subscription tier.
| +| | `string` | The unique ID of this Subscription tier.
| +| | `integer` | The number of Longview Clients that may be created with this Subscription tier.
| +| | `string` | A display name for this Subscription tier.
| +| | `object` | Pricing information about this Subscription tier.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getLongviewSubscription` | `SELECT` | `subscriptionId` | Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication.
| -| `getLongviewSubscriptions` | `SELECT` | | Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.
| -| `_getLongviewSubscription` | `EXEC` | `subscriptionId` | Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication.
| -| `_getLongviewSubscriptions` | `EXEC` | | Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.
| +| | `SELECT` | | Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication.
| +| | `SELECT` | | Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.
| +| | `EXEC` | | Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication.
| +| | `EXEC` | | Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.
| diff --git a/docs/linode-docs/providers/linode/managed/contacts/index.md b/docs/linode-docs/providers/linode/managed/contacts/index.md index 0ec0f344d8..462d59f6c4 100644 --- a/docs/linode-docs/providers/linode/managed/contacts/index.md +++ b/docs/linode-docs/providers/linode/managed/contacts/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontacts
TypeResource
Idlinode.managed.contacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Contact's unique ID.
| -| `name` | `string` | The name of this Contact.
| -| `email` | `string` | The address to email this Contact to alert them of issues.
| -| `group` | `string` | A grouping for this Contact. This is for display purposes only.
| -| `phone` | `object` | Information about how to reach this Contact by phone.
| -| `updated` | `string` | When this Contact was last updated.
| +| | `integer` | This Contact's unique ID.
| +| | `string` | The name of this Contact.
| +| | `string` | The address to email this Contact to alert them of issues.
| +| | `string` | A grouping for this Contact. This is for display purposes only.
| +| | `object` | Information about how to reach this Contact by phone.
| +| | `string` | When this Contact was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getManagedContact` | `SELECT` | `contactId` | Returns a single Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| -| `getManagedContacts` | `SELECT` | | Returns a paginated list of Managed Contacts on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `createManagedContact` | `INSERT` | | Creates a Managed Contact. A Managed Contact is someone Linode
special forces can contact in the course of attempting to resolve an issue
with a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| -| `deleteManagedContact` | `DELETE` | `contactId` | Deletes a Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedContact` | `EXEC` | `contactId` | Returns a single Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedContacts` | `EXEC` | | Returns a paginated list of Managed Contacts on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `updateManagedContact` | `EXEC` | `contactId` | Updates information about a Managed Contact.
This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a single Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of Managed Contacts on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `INSERT` | | Creates a Managed Contact. A Managed Contact is someone Linode
special forces can contact in the course of attempting to resolve an issue
with a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| +| | `DELETE` | | Deletes a Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a single Managed Contact.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a paginated list of Managed Contacts on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Updates information about a Managed Contact.
This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/managed/credentials/index.md b/docs/linode-docs/providers/linode/managed/credentials/index.md index 9b7eebeff9..500fd15c9d 100644 --- a/docs/linode-docs/providers/linode/managed/credentials/index.md +++ b/docs/linode-docs/providers/linode/managed/credentials/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecredentials
TypeResource
Idlinode.managed.credentials
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Credential's unique ID.
| -| `label` | `string` | The unique label for this Credential. This is for display purposes only.
| -| `last_decrypted` | `string` | The date this Credential was last decrypted by a member of Linode special forces.
| +| | `integer` | This Credential's unique ID.
| +| | `string` | The unique label for this Credential. This is for display purposes only.
| +| | `string` | The date this Credential was last decrypted by a member of Linode special forces.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getManagedCredential` | `SELECT` | `credentialId` | Returns a single Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| -| `getManagedCredentials` | `SELECT` | | Returns a paginated list of Managed Credentials on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `createManagedCredential` | `INSERT` | `data__label, data__password` | Creates a Managed Credential. A Managed Credential is stored securely
to allow Linode special forces to access your Managed Services and resolve
issues.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedCredential` | `EXEC` | `credentialId` | Returns a single Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedCredentials` | `EXEC` | | Returns a paginated list of Managed Credentials on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `_viewManagedSSHKey` | `EXEC` | | Returns the unique SSH public key assigned to your Linode account's
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
Linode special forces will be able to log in to the Linode with this key
when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| -| `deleteManagedCredential` | `EXEC` | `credentialId` | Deletes a Managed Credential. Linode special forces will no longer
have access to this Credential when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| -| `updateManagedCredential` | `EXEC` | `credentialId` | Updates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. To do this, use the Managed Credential Username and Password Update ([POST /managed/credentials/{credentialId}/update](/docs/api/managed/#managed-credential-username-and-password-update)) endpoint instead.
This command can only be accessed by the unrestricted users of an account.
| -| `updateManagedCredentialUsernamePassword` | `EXEC` | `credentialId, data__password` | Updates the username and password for a Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| -| `viewManagedSSHKey` | `EXEC` | | Returns the unique SSH public key assigned to your Linode account's
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
Linode special forces will be able to log in to the Linode with this key
when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a single Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of Managed Credentials on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `INSERT` | | Creates a Managed Credential. A Managed Credential is stored securely
to allow Linode special forces to access your Managed Services and resolve
issues.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a single Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a paginated list of Managed Credentials on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns the unique SSH public key assigned to your Linode account's
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
Linode special forces will be able to log in to the Linode with this key
when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Deletes a Managed Credential. Linode special forces will no longer
have access to this Credential when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Updates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. To do this, use the Managed Credential Username and Password Update ([POST /managed/credentials/{credentialId}/update](/docs/api/managed/#managed-credential-username-and-password-update)) endpoint instead.
This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Updates the username and password for a Managed Credential.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns the unique SSH public key assigned to your Linode account's
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
Linode special forces will be able to log in to the Linode with this key
when attempting to resolve issues.

This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/managed/index.md b/docs/linode-docs/providers/linode/managed/index.md index 79482bc4e5..eba14e3025 100644 --- a/docs/linode-docs/providers/linode/managed/index.md +++ b/docs/linode-docs/providers/linode/managed/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Managed :::info Service Summary diff --git a/docs/linode-docs/providers/linode/managed/issues/index.md b/docs/linode-docs/providers/linode/managed/issues/index.md index 7544d09a51..b5e9a2485e 100644 --- a/docs/linode-docs/providers/linode/managed/issues/index.md +++ b/docs/linode-docs/providers/linode/managed/issues/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameissues
TypeResource
Idlinode.managed.issues
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Issue's unique ID.
| -| `entity` | `object` | The ticket this Managed Issue opened.
| -| `services` | `array` | An array of Managed Service IDs that were affected by this Issue.
| -| `created` | `string` | When this Issue was created. Issues are created in response to issues detected with Managed Services, so this is also when the Issue was detected.
| +| | `integer` | This Issue's unique ID.
| +| | `string` | When this Issue was created. Issues are created in response to issues detected with Managed Services, so this is also when the Issue was detected.
| +| | `object` | The ticket this Managed Issue opened.
| +| | `array` | An array of Managed Service IDs that were affected by this Issue.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getManagedIssue` | `SELECT` | `issueId` | Returns a single Issue that is impacting or did impact one of your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| -| `getManagedIssues` | `SELECT` | | Returns a paginated list of recent and ongoing issues detected on your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedIssue` | `EXEC` | `issueId` | Returns a single Issue that is impacting or did impact one of your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedIssues` | `EXEC` | | Returns a paginated list of recent and ongoing issues detected on your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a single Issue that is impacting or did impact one of your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of recent and ongoing issues detected on your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a single Issue that is impacting or did impact one of your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a paginated list of recent and ongoing issues detected on your
Managed Services.

This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/managed/linode_settings/index.md b/docs/linode-docs/providers/linode/managed/linode_settings/index.md index 99847d798a..a5a8c508ba 100644 --- a/docs/linode-docs/providers/linode/managed/linode_settings/index.md +++ b/docs/linode-docs/providers/linode/managed/linode_settings/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelinode_settings
TypeResource
Idlinode.managed.linode_settings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of the Linode these Settings are for.
| -| `label` | `string` | The label of the Linode these Settings are for.
| -| `ssh` | `object` | The SSH settings for this Linode.
| -| `group` | `string` | The group of the Linode these Settings are for. This is for display purposes only.
| +| | `integer` | The ID of the Linode these Settings are for.
| +| | `string` | The group of the Linode these Settings are for. This is for display purposes only.
| +| | `string` | The label of the Linode these Settings are for.
| +| | `object` | The SSH settings for this Linode.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getManagedLinodeSetting` | `SELECT` | `linodeId` | Returns a single Linode's Managed settings.

This command can only be accessed by the unrestricted users of an account.
| -| `getManagedLinodeSettings` | `SELECT` | | Returns a paginated list of Managed Settings for your Linodes. There will
be one entry per Linode on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedLinodeSetting` | `EXEC` | `linodeId` | Returns a single Linode's Managed settings.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedLinodeSettings` | `EXEC` | | Returns a paginated list of Managed Settings for your Linodes. There will
be one entry per Linode on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `updateManagedLinodeSetting` | `EXEC` | `linodeId` | Updates a single Linode's Managed settings.
This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a single Linode's Managed settings.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of Managed Settings for your Linodes. There will
be one entry per Linode on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a single Linode's Managed settings.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a paginated list of Managed Settings for your Linodes. There will
be one entry per Linode on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Updates a single Linode's Managed settings.
This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/managed/services/index.md b/docs/linode-docs/providers/linode/managed/services/index.md index fcc604588c..64b9bc55a6 100644 --- a/docs/linode-docs/providers/linode/managed/services/index.md +++ b/docs/linode-docs/providers/linode/managed/services/index.md @@ -14,41 +14,44 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices
TypeResource
Idlinode.managed.services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This Service's unique ID.
| -| `address` | `string` | The URL at which this Service is monitored.

URL parameters such as `?no-cache=1` are preserved.

URL fragments/anchors such as `#monitor` are **not** preserved.
| -| `consultation_group` | `string` | The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
| -| `status` | `string` | The current status of this Service.
| -| `label` | `string` | The label for this Service. This is for display purposes only.
| -| `notes` | `string` | Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
| -| `service_type` | `string` | How this Service is monitored.
| -| `created` | `string` | When this Managed Service was created. | -| `credentials` | `array` | An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
| -| `region` | `string` | The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
| -| `timeout` | `integer` | How long to wait, in seconds, for a response before considering the Service to be down.
| -| `updated` | `string` | When this Managed Service was last updated. | -| `body` | `string` | What to expect to find in the response body for the Service to be considered up.
| +| | `integer` | This Service's unique ID.
| +| | `string` | The URL at which this Service is monitored.

URL parameters such as `?no-cache=1` are preserved.

URL fragments/anchors such as `#monitor` are **not** preserved.
| +| | `string` | What to expect to find in the response body for the Service to be considered up.
| +| | `string` | The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
| +| | `string` | When this Managed Service was created. | +| | `array` | An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
| +| | `string` | The label for this Service. This is for display purposes only.
| +| | `string` | Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
| +| | `string` | The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
| +| | `string` | How this Service is monitored.
| +| | `string` | The current status of this Service.
| +| | `integer` | How long to wait, in seconds, for a response before considering the Service to be down.
| +| | `string` | When this Managed Service was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getManagedService` | `SELECT` | `serviceId` | Returns information about a single Managed Service on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `getManagedServices` | `SELECT` | | Returns a paginated list of Managed Services on your Account. These
are the services Linode Managed is monitoring and will report and attempt
to resolve issues with.

This command can only be accessed by the unrestricted users of an account.
| -| `createManagedService` | `INSERT` | `data__address, data__label, data__service_type, data__timeout` | Creates a Managed Service. Linode Managed will begin monitoring this
service and reporting and attempting to resolve any Issues.

This command can only be accessed by the unrestricted users of an account.
| -| `deleteManagedService` | `DELETE` | `serviceId` | Deletes a Managed Service. This service will no longer be monitored by
Linode Managed.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedService` | `EXEC` | `serviceId` | Returns information about a single Managed Service on your Account.

This command can only be accessed by the unrestricted users of an account.
| -| `_getManagedServices` | `EXEC` | | Returns a paginated list of Managed Services on your Account. These
are the services Linode Managed is monitoring and will report and attempt
to resolve issues with.

This command can only be accessed by the unrestricted users of an account.
| -| `disableManagedService` | `EXEC` | `serviceId` | Temporarily disables monitoring of a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| -| `enableManagedService` | `EXEC` | `serviceId` | Enables monitoring of a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| -| `updateManagedService` | `EXEC` | `serviceId` | Updates information about a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns information about a single Managed Service on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `SELECT` | | Returns a paginated list of Managed Services on your Account. These
are the services Linode Managed is monitoring and will report and attempt
to resolve issues with.

This command can only be accessed by the unrestricted users of an account.
| +| | `INSERT` | | Creates a Managed Service. Linode Managed will begin monitoring this
service and reporting and attempting to resolve any Issues.

This command can only be accessed by the unrestricted users of an account.
| +| | `DELETE` | | Deletes a Managed Service. This service will no longer be monitored by
Linode Managed.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns information about a single Managed Service on your Account.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Returns a paginated list of Managed Services on your Account. These
are the services Linode Managed is monitoring and will report and attempt
to resolve issues with.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Temporarily disables monitoring of a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Enables monitoring of a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| +| | `EXEC` | | Updates information about a Managed Service.

This command can only be accessed by the unrestricted users of an account.
| diff --git a/docs/linode-docs/providers/linode/managed/stats/index.md b/docs/linode-docs/providers/linode/managed/stats/index.md index fea799ef59..32b12ed947 100644 --- a/docs/linode-docs/providers/linode/managed/stats/index.md +++ b/docs/linode-docs/providers/linode/managed/stats/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestats
TypeResource
Idlinode.managed.stats
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `_getManagedStats` | `EXEC` | | -| `getManagedStats` | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/networking/assign/index.md b/docs/linode-docs/providers/linode/networking/assign/index.md index b381d9675a..bd8b26883a 100644 --- a/docs/linode-docs/providers/linode/networking/assign/index.md +++ b/docs/linode-docs/providers/linode/networking/assign/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameassign
TypeResource
Idlinode.networking.assign
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `assignIPv4s` | `EXEC` | `data__assignments, data__region` | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/networking/firewalls/index.md b/docs/linode-docs/providers/linode/networking/firewalls/index.md index b70d8b3471..0ee700ea51 100644 --- a/docs/linode-docs/providers/linode/networking/firewalls/index.md +++ b/docs/linode-docs/providers/linode/networking/firewalls/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls
TypeResource
Idlinode.networking.firewalls
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The Firewall's unique ID.
| -| `status` | `string` | The status of this Firewall.

* When a Firewall is first created its status is `enabled`.
* Use the [Update Firewall](/docs/api/networking/#firewall-update) endpoint to set a Firewall's status to `enabled` or `disabled`.
* Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.
| -| `tags` | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| -| `updated` | `string` | When this Firewall was last updated.
| -| `created` | `string` | When this Firewall was created.
| -| `label` | `string` | The Firewall's label, for display purposes only.

Firewall labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
* Must be between 3 and 32 characters.
* Must be unique.
| -| `rules` | `object` | The inbound and outbound access rules to apply to the Firewall.

A Firewall may have up to 25 rules across its inbound and outbound rulesets.
| +| | `integer` | The Firewall's unique ID.
| +| | `string` | When this Firewall was created.
| +| | `string` | The Firewall's label, for display purposes only.

Firewall labels have the following constraints:

* Must begin and end with an alphanumeric character.
* May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
* Must be between 3 and 32 characters.
* Must be unique.
| +| | `object` | The inbound and outbound access rules to apply to the Firewall.

A Firewall may have up to 25 rules across its inbound and outbound rulesets.
| +| | `string` | The status of this Firewall.

* When a Firewall is first created its status is `enabled`.
* Use the [Update Firewall](/docs/api/networking/#firewall-update) endpoint to set a Firewall's status to `enabled` or `disabled`.
* Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.
| +| | `array` | An array of tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | When this Firewall was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getFirewall` | `SELECT` | `firewallId` | Get a specific Firewall resource by its ID. The Firewall's Devices will not be
returned in the response. Instead, use the
[List Firewall Devices](/docs/api/networking/#firewall-devices-list)
endpoint to review them.
| -| `getFirewalls` | `SELECT` | | Returns a paginated list of accessible Firewalls.
| -| `createFirewalls` | `INSERT` | `data__rules` | Creates a Firewall to filter network traffic.

* Use the `rules` property to create inbound and outbound access rules.

* Use the `devices` property to assign the Firewall to a service and apply its Rules to the device. Requires `read_write` [User's Grants](/docs/api/account/#users-grants-view) to the device.
Currently, Firewalls can only be assigned to Linode instances.

* A Firewall can be assigned to multiple Linode instances at a time.

* A Linode instance can have one active, assigned Firewall at a time.
Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.

* A `firewall_create` Event is generated when this endpoint returns successfully.
| -| `deleteFirewall` | `DELETE` | `firewallId` | Delete a Firewall resource by its ID. This will remove all of the Firewall's Rules
from any Linode services that the Firewall was assigned to.

A `firewall_delete` Event is generated when this endpoint returns successfully.
| -| `_getFirewall` | `EXEC` | `firewallId` | Get a specific Firewall resource by its ID. The Firewall's Devices will not be
returned in the response. Instead, use the
[List Firewall Devices](/docs/api/networking/#firewall-devices-list)
endpoint to review them.
| -| `_getFirewalls` | `EXEC` | | Returns a paginated list of accessible Firewalls.
| -| `updateFirewall` | `EXEC` | `firewallId` | Updates information for a Firewall. Some parts of a Firewall's configuration cannot
be manipulated by this endpoint:

- A Firewall's Devices cannot be set with this endpoint. Instead, use the
[Create Firewall Device](/docs/api/networking/#firewall-device-create)
and [Delete Firewall Device](/docs/api/networking/#firewall-device-delete)
endpoints to assign and remove this Firewall from Linode services.

- A Firewall's Rules cannot be changed with this endpoint. Instead, use the
[Update Firewall Rules](/docs/api/networking/#firewall-rules-update)
endpoint to update your Rules.

- A Firewall's status can be set to `enabled` or `disabled` by this endpoint, but it cannot be
set to `deleted`. Instead, use the
[Delete Firewall](/docs/api/networking/#firewall-delete)
endpoint to delete a Firewall.

If a Firewall's status is changed with this endpoint, a corresponding `firewall_enable` or
`firewall_disable` Event will be generated.
| +| | `SELECT` | | Get a specific Firewall resource by its ID. The Firewall's Devices will not be
returned in the response. Instead, use the
[List Firewall Devices](/docs/api/networking/#firewall-devices-list)
endpoint to review them.
| +| | `SELECT` | | Returns a paginated list of accessible Firewalls.
| +| | `INSERT` | | Creates a Firewall to filter network traffic.

* Use the `rules` property to create inbound and outbound access rules.

* Use the `devices` property to assign the Firewall to a service and apply its Rules to the device. Requires `read_write` [User's Grants](/docs/api/account/#users-grants-view) to the device.
Currently, Firewalls can only be assigned to Linode instances.

* A Firewall can be assigned to multiple Linode instances at a time.

* A Linode instance can have one active, assigned Firewall at a time.
Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.

* A `firewall_create` Event is generated when this endpoint returns successfully.
| +| | `DELETE` | | Delete a Firewall resource by its ID. This will remove all of the Firewall's Rules
from any Linode services that the Firewall was assigned to.

A `firewall_delete` Event is generated when this endpoint returns successfully.
| +| | `EXEC` | | Get a specific Firewall resource by its ID. The Firewall's Devices will not be
returned in the response. Instead, use the
[List Firewall Devices](/docs/api/networking/#firewall-devices-list)
endpoint to review them.
| +| | `EXEC` | | Returns a paginated list of accessible Firewalls.
| +| | `EXEC` | | Updates information for a Firewall. Some parts of a Firewall's configuration cannot
be manipulated by this endpoint:

- A Firewall's Devices cannot be set with this endpoint. Instead, use the
[Create Firewall Device](/docs/api/networking/#firewall-device-create)
and [Delete Firewall Device](/docs/api/networking/#firewall-device-delete)
endpoints to assign and remove this Firewall from Linode services.

- A Firewall's Rules cannot be changed with this endpoint. Instead, use the
[Update Firewall Rules](/docs/api/networking/#firewall-rules-update)
endpoint to update your Rules.

- A Firewall's status can be set to `enabled` or `disabled` by this endpoint, but it cannot be
set to `deleted`. Instead, use the
[Delete Firewall](/docs/api/networking/#firewall-delete)
endpoint to delete a Firewall.

If a Firewall's status is changed with this endpoint, a corresponding `firewall_enable` or
`firewall_disable` Event will be generated.
| diff --git a/docs/linode-docs/providers/linode/networking/firewalls_devices/index.md b/docs/linode-docs/providers/linode/networking/firewalls_devices/index.md index 07ae2597f8..d38710f837 100644 --- a/docs/linode-docs/providers/linode/networking/firewalls_devices/index.md +++ b/docs/linode-docs/providers/linode/networking/firewalls_devices/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls_devices
TypeResource
Idlinode.networking.firewalls_devices
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The Device's unique ID
| -| `entity` | `object` | The Linode service that this Firewall has been applied to.
| -| `updated` | `string` | When this Device was last updated.
| -| `created` | `string` | When this Device was created.
| +| | `integer` | The Device's unique ID
| +| | `string` | When this Device was created.
| +| | `object` | The Linode service that this Firewall has been applied to.
| +| | `string` | When this Device was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getFirewallDevice` | `SELECT` | `deviceId, firewallId` | Returns information for a Firewall Device, which assigns a Firewall
to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| -| `getFirewallDevices` | `SELECT` | `firewallId` | Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a
Firewall to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| -| `createFirewallDevice` | `INSERT` | `firewallId, data__id, data__type` | Creates a Firewall Device, which assigns a Firewall to a service (referred to
as the Device's `entity`) and applies the Firewall's Rules to the device.

* Currently, only Devices with an entity of type `linode` are accepted.

* A Firewall can be assigned to multiple Linode instances at a time.

* A Linode instance can have one active, assigned Firewall at a time.
Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.

* A `firewall_device_add` Event is generated when the Firewall Device is added successfully.
| -| `deleteFirewallDevice` | `DELETE` | `deviceId, firewallId` | Removes a Firewall Device, which removes a Firewall from the Linode service it was
assigned to by the Device. This will remove all of the Firewall's Rules from the Linode
service. If any other Firewalls have been assigned to the Linode service, then those Rules
will remain in effect.

A `firewall_device_remove` Event is generated when the Firewall Device is removed successfully.
| -| `_getFirewallDevice` | `EXEC` | `deviceId, firewallId` | Returns information for a Firewall Device, which assigns a Firewall
to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| -| `_getFirewallDevices` | `EXEC` | `firewallId` | Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a
Firewall to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| +| | `SELECT` | | Returns information for a Firewall Device, which assigns a Firewall
to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| +| | `SELECT` | | Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a
Firewall to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| +| | `INSERT` | | Creates a Firewall Device, which assigns a Firewall to a service (referred to
as the Device's `entity`) and applies the Firewall's Rules to the device.

* Currently, only Devices with an entity of type `linode` are accepted.

* A Firewall can be assigned to multiple Linode instances at a time.

* A Linode instance can have one active, assigned Firewall at a time.
Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.

* A `firewall_device_add` Event is generated when the Firewall Device is added successfully.
| +| | `DELETE` | | Removes a Firewall Device, which removes a Firewall from the Linode service it was
assigned to by the Device. This will remove all of the Firewall's Rules from the Linode
service. If any other Firewalls have been assigned to the Linode service, then those Rules
will remain in effect.

A `firewall_device_remove` Event is generated when the Firewall Device is removed successfully.
| +| | `EXEC` | | Returns information for a Firewall Device, which assigns a Firewall
to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| +| | `EXEC` | | Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a
Firewall to a Linode service (referred to as the Device's `entity`). Currently,
only Devices with an entity of type `linode` are accepted.
| diff --git a/docs/linode-docs/providers/linode/networking/firewalls_rules/index.md b/docs/linode-docs/providers/linode/networking/firewalls_rules/index.md index 57e5420dc8..745075b9eb 100644 --- a/docs/linode-docs/providers/linode/networking/firewalls_rules/index.md +++ b/docs/linode-docs/providers/linode/networking/firewalls_rules/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefirewalls_rules
TypeResource
Idlinode.networking.firewalls_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `outbound` | `array` | The outbound rules for the firewall, as a JSON array.
| -| `outbound_policy` | `string` | The default behavior for outbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `outbound.action` property of the Firewall Rule.
| -| `inbound` | `array` | The inbound rules for the firewall, as a JSON array.
| -| `inbound_policy` | `string` | The default behavior for inbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `inbound.action` property of the Firewall Rule.
| +| | `array` | The inbound rules for the firewall, as a JSON array.
| +| | `string` | The default behavior for inbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `inbound.action` property of the Firewall Rule.
| +| | `array` | The outbound rules for the firewall, as a JSON array.
| +| | `string` | The default behavior for outbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `outbound.action` property of the Firewall Rule.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getFirewallRules` | `SELECT` | `firewallId` | Returns the inbound and outbound Rules for a Firewall.
| -| `_getFirewallRules` | `EXEC` | `firewallId` | Returns the inbound and outbound Rules for a Firewall.
| -| `updateFirewallRules` | `EXEC` | `firewallId` | Updates the inbound and outbound Rules for a Firewall.

**Note:** This command replaces all of a Firewall's `inbound` and/or `outbound` rulesets with the values specified in your request.
| +| | `SELECT` | | Returns the inbound and outbound Rules for a Firewall.
| +| | `EXEC` | | Returns the inbound and outbound Rules for a Firewall.
| +| | `EXEC` | | Updates the inbound and outbound Rules for a Firewall.

**Note:** This command replaces all of a Firewall's `inbound` and/or `outbound` rulesets with the values specified in your request.
| diff --git a/docs/linode-docs/providers/linode/networking/index.md b/docs/linode-docs/providers/linode/networking/index.md index cecb0182e1..ac47031ed5 100644 --- a/docs/linode-docs/providers/linode/networking/index.md +++ b/docs/linode-docs/providers/linode/networking/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Networking :::info Service Summary diff --git a/docs/linode-docs/providers/linode/networking/ips/index.md b/docs/linode-docs/providers/linode/networking/ips/index.md index aea01054f1..4bbfc766a9 100644 --- a/docs/linode-docs/providers/linode/networking/ips/index.md +++ b/docs/linode-docs/providers/linode/networking/ips/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameips
TypeResource
Idlinode.networking.ips
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `subnet_mask` | `string` | The mask that separates host bits from network bits for this address.
| -| `linode_id` | `integer` | The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the [/networking/ipv4/assign](/docs/api/networking/#ips-to-linodes-assign) endpoint. For SLAAC and link-local addresses, this value may not be changed.
| -| `type` | `string` | The type of address this is.
| -| `address` | `string` | The IP address.
| -| `rdns` | `string` | The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.
| -| `region` | `string` | The Region this IP address resides in.
| -| `prefix` | `integer` | The number of bits set in the subnet mask.
| -| `gateway` | `string` | The default gateway for this address.
| -| `public` | `boolean` | Whether this is a public or private IP address.
| +| | `string` | The IP address.
| +| | `string` | The default gateway for this address.
| +| | `integer` | The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the [/networking/ipv4/assign](/docs/api/networking/#ips-to-linodes-assign) endpoint. For SLAAC and link-local addresses, this value may not be changed.
| +| | `integer` | The number of bits set in the subnet mask.
| +| | `boolean` | Whether this is a public or private IP address.
| +| | `string` | The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.
| +| | `string` | The Region this IP address resides in.
| +| | `string` | The mask that separates host bits from network bits for this address.
| +| | `string` | The type of address this is.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getIP` | `SELECT` | `address` | Returns information about a single IP Address on your Account.
| -| `getIPs` | `SELECT` | | Returns a paginated list of IP Addresses on your Account, excluding private addresses.
| -| `_getIP` | `EXEC` | `address` | Returns information about a single IP Address on your Account.
| -| `_getIPs` | `EXEC` | | Returns a paginated list of IP Addresses on your Account, excluding private addresses.
| -| `allocateIP` | `EXEC` | `data__linode_id, data__public, data__type` | Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please [open a support ticket](/docs/api/support/#support-ticket-open) requesting additional addresses before attempting allocation.
| -| `assignIPs` | `EXEC` | `data__assignments, data__region` | Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.

The following restrictions apply:
* All Linodes involved must have at least one public IPv4 address after assignment.
* Linodes may have no more than one assigned private IPv4 address.
* Linodes may have no more than one assigned IPv6 range.

[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.

**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:
* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))
* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))
| -| `shareIPs` | `EXEC` | `data__ips, data__linode_id` | Configure shared IPs.

IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.

IP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived)) within the internal system of the primary Linode.
| -| `updateIP` | `EXEC` | `address, data__rdns` | Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to `null` for public IPv4 addresses, it will be reset to the default _ip.linodeusercontent.com_ RDNS value.
| +| | `SELECT` | | Returns information about a single IP Address on your Account.
| +| | `SELECT` | | Returns a paginated list of IP Addresses on your Account, excluding private addresses.
| +| | `EXEC` | | Returns information about a single IP Address on your Account.
| +| | `EXEC` | | Returns a paginated list of IP Addresses on your Account, excluding private addresses.
| +| | `EXEC` | | Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please [open a support ticket](/docs/api/support/#support-ticket-open) requesting additional addresses before attempting allocation.
| +| | `EXEC` | | Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.

The following restrictions apply:
* All Linodes involved must have at least one public IPv4 address after assignment.
* Linodes may have no more than one assigned private IPv4 address.
* Linodes may have no more than one assigned IPv6 range.

[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.

**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:
* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))
* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))
| +| | `EXEC` | | Configure shared IPs.

IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.

IP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived)) within the internal system of the primary Linode.
| +| | `EXEC` | | Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to `null` for public IPv4 addresses, it will be reset to the default _ip.linodeusercontent.com_ RDNS value.
| diff --git a/docs/linode-docs/providers/linode/networking/pools/index.md b/docs/linode-docs/providers/linode/networking/pools/index.md index 96a7481933..69c3524079 100644 --- a/docs/linode-docs/providers/linode/networking/pools/index.md +++ b/docs/linode-docs/providers/linode/networking/pools/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepools
TypeResource
Idlinode.networking.pools
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `prefix` | `integer` | The prefix length of the address, denoting how many addresses can be assigned from this pool calculated as 2 <sup>128-prefix</sup>.
| -| `range` | `string` | The IPv6 range of addresses in this pool.
| -| `region` | `string` | The region for this pool of IPv6 addresses.
| -| `route_target` | `string` | The last address in this block of IPv6 addresses.
| +| | `integer` | The prefix length of the address, denoting how many addresses can be assigned from this pool calculated as 2 <sup>128-prefix</sup>.
| +| | `string` | The IPv6 range of addresses in this pool.
| +| | `string` | The region for this pool of IPv6 addresses.
| +| | `string` | The last address in this block of IPv6 addresses.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getIPv6Pools` | `SELECT` | | -| `_getIPv6Pools` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/networking/ranges/index.md b/docs/linode-docs/providers/linode/networking/ranges/index.md index 0a0f592636..bde40b3b4c 100644 --- a/docs/linode-docs/providers/linode/networking/ranges/index.md +++ b/docs/linode-docs/providers/linode/networking/ranges/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameranges
TypeResource
Idlinode.networking.ranges
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `range` | `string` | The IPv6 range of addresses in this pool.
| -| `region` | `string` | The region for this range of IPv6 addresses.
| -| `route_target` | `string` | The last address in this block of IPv6 addresses.
| -| `prefix` | `integer` | The prefix length of the address, denoting how many addresses can be assigned from this range calculated as 2 <sup>128-prefix</sup>.
| +| | `integer` | The prefix length of the address, denoting how many addresses can be assigned from this range calculated as 2 <sup>128-prefix</sup>.
| +| | `string` | The IPv6 range of addresses in this pool.
| +| | `string` | The region for this range of IPv6 addresses.
| +| | `string` | The last address in this block of IPv6 addresses.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getIPv6Range` | `SELECT` | `range` | View IPv6 range information.
| -| `getIPv6Ranges` | `SELECT` | | Displays the IPv6 ranges on your Account.


* An IPv6 range is a `/64` or `/54` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#regions-list).

* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.

* Access the IPv6 Range Create ([POST /networking/ipv6/ranges](/docs/api/networking/#ipv6-range-create)) endpoint to add a `/64` or `/56` block of IPv6 addresses to your account.
| -| `deleteIPv6Range` | `DELETE` | `range` | Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.

**Note:** Shared IPv6 ranges cannot be deleted at this time. Please contact Customer Support for assistance.
| -| `_getIPv6Range` | `EXEC` | `range` | View IPv6 range information.
| -| `_getIPv6Ranges` | `EXEC` | | Displays the IPv6 ranges on your Account.


* An IPv6 range is a `/64` or `/54` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#regions-list).

* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.

* Access the IPv6 Range Create ([POST /networking/ipv6/ranges](/docs/api/networking/#ipv6-range-create)) endpoint to add a `/64` or `/56` block of IPv6 addresses to your account.
| -| `postIPv6Range` | `EXEC` | `data__prefix_length` | Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when accessing the Linode View ([GET /linode/instances/{linodeId}](/docs/api/linode-instances/#linode-view)) endpoint to view a Linode's IPv6 SLAAC address.
* Either `linode_id` or `route_target` is required in a request.
* `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.
* Upon a successful request, an IPv6 range is created in the [Region](/docs/api/regions/#regions-list) that corresponds to the provided `linode_id` or `route_target`.
* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.
* Access the IP Addresses Assign ([POST /networking/ips/assign](/docs/api/networking/#ip-addresses-assign)) endpoint to re-assign IPv6 Ranges to your Linodes.

**Note**: The following restrictions apply:
* A Linode can only have one IPv6 range targeting its SLAAC address.
* An account can only have one IPv6 range in each [Region](/docs/api/regions/#regions-list).
* [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request expansion of these restrictions.
| +| | `SELECT` | | View IPv6 range information.
| +| | `SELECT` | | Displays the IPv6 ranges on your Account.


* An IPv6 range is a `/64` or `/54` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#regions-list).

* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.

* Access the IPv6 Range Create ([POST /networking/ipv6/ranges](/docs/api/networking/#ipv6-range-create)) endpoint to add a `/64` or `/56` block of IPv6 addresses to your account.
| +| | `DELETE` | | Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.

**Note:** Shared IPv6 ranges cannot be deleted at this time. Please contact Customer Support for assistance.
| +| | `EXEC` | | View IPv6 range information.
| +| | `EXEC` | | Displays the IPv6 ranges on your Account.


* An IPv6 range is a `/64` or `/54` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#regions-list).

* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.

* Access the IPv6 Range Create ([POST /networking/ipv6/ranges](/docs/api/networking/#ipv6-range-create)) endpoint to add a `/64` or `/56` block of IPv6 addresses to your account.
| +| | `EXEC` | | Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when accessing the Linode View ([GET /linode/instances/{linodeId}](/docs/api/linode-instances/#linode-view)) endpoint to view a Linode's IPv6 SLAAC address.
* Either `linode_id` or `route_target` is required in a request.
* `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.
* Upon a successful request, an IPv6 range is created in the [Region](/docs/api/regions/#regions-list) that corresponds to the provided `linode_id` or `route_target`.
* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.
* Access the IP Addresses Assign ([POST /networking/ips/assign](/docs/api/networking/#ip-addresses-assign)) endpoint to re-assign IPv6 Ranges to your Linodes.

**Note**: The following restrictions apply:
* A Linode can only have one IPv6 range targeting its SLAAC address.
* An account can only have one IPv6 range in each [Region](/docs/api/regions/#regions-list).
* [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request expansion of these restrictions.
| diff --git a/docs/linode-docs/providers/linode/networking/share/index.md b/docs/linode-docs/providers/linode/networking/share/index.md index 2c7f3a59db..cce9bdba26 100644 --- a/docs/linode-docs/providers/linode/networking/share/index.md +++ b/docs/linode-docs/providers/linode/networking/share/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameshare
TypeResource
Idlinode.networking.share
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `shareIPv4s` | `EXEC` | `data__ips, data__linode_id` | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/networking/vlans/index.md b/docs/linode-docs/providers/linode/networking/vlans/index.md index 5516a36528..6578cca6dc 100644 --- a/docs/linode-docs/providers/linode/networking/vlans/index.md +++ b/docs/linode-docs/providers/linode/networking/vlans/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevlans
TypeResource
Idlinode.networking.vlans
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `created` | `string` | The date this VLAN was created.
| -| `label` | `string` | The name of this VLAN. | -| `linodes` | `array` | An array of Linode IDs attached to this VLAN.
| -| `region` | `string` | This VLAN's data center region.

**Note:** Currently, a VLAN can only be assigned to a Linode
within the same data center region.
| +| | `string` | The date this VLAN was created.
| +| | `string` | The name of this VLAN. | +| | `array` | An array of Linode IDs attached to this VLAN.
| +| | `string` | This VLAN's data center region.

**Note:** Currently, a VLAN can only be assigned to a Linode
within the same data center region.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getVLANs` | `SELECT` | | -| `_getVLANs` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/nodebalancers/configs/index.md b/docs/linode-docs/providers/linode/nodebalancers/configs/index.md index 97cc31b4f0..7512c742b0 100644 --- a/docs/linode-docs/providers/linode/nodebalancers/configs/index.md +++ b/docs/linode-docs/providers/linode/nodebalancers/configs/index.md @@ -14,47 +14,50 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfigs
TypeResource
Idlinode.nodebalancers.configs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This config's unique ID | -| `check_passive` | `boolean` | If true, any response from this backend with a `5xx` status code will be enough for it to be considered unhealthy and taken out of rotation.
| -| `proxy_protocol` | `string` | ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices. This information would be lost otherwise. Backend devices must be configured to work with ProxyProtocol if enabled.

* If ommited, or set to `none`, the NodeBalancer doesn't send any auxilary data over TCP connections. This is the default.
* If set to `v1`, the human-readable header format (Version 1) is used. Requires `tcp` protocol.
* If set to `v2`, the binary header format (Version 2) is used. Requires `tcp` protocol.
| -| `port` | `integer` | The port this Config is for. These values must be unique across configs on a single NodeBalancer (you can't have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443.
| -| `check_attempts` | `integer` | How many times to attempt a check before considering a backend to be down.
| -| `ssl_fingerprint` | `string` | The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
| -| `algorithm` | `string` | What algorithm this NodeBalancer should use for routing traffic to backends.
| -| `protocol` | `string` | The protocol this port is configured to serve.

* The `http` and `tcp` protocols do not support `ssl_cert` and `ssl_key`.

* The `https` protocol is mutually required with `ssl_cert` and `ssl_key`.

Review our guide on [Available Protocols](/docs/products/networking/nodebalancers/guides/protocols/) for information on protocol features.
| -| `check_interval` | `integer` | How often, in seconds, to check that backends are up and serving requests.

Must be greater than `check_timeout`.
| -| `check_timeout` | `integer` | How long, in seconds, to wait for a check attempt before considering it failed.

Must be less than `check_interval`.
| -| `check` | `string` | The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down.
* If `none` no check is performed.
* `connection` requires only a connection to the backend to succeed.
* `http` and `http_body` rely on the backend serving HTTP, and that
the response returned matches what is expected.
| -| `nodebalancer_id` | `integer` | The ID for the NodeBalancer this config belongs to.
| -| `stickiness` | `string` | Controls how session stickiness is handled on this port.
* If set to `none` connections will always be assigned a backend based on the algorithm configured.
* If set to `table` sessions from the same remote address will be routed to the same
backend.

* For HTTP or HTTPS clients, `http_cookie` allows sessions to be
routed to the same backend based on a cookie set by the NodeBalancer.
| -| `nodes_status` | `object` | A structure containing information about the health of the backends for this port. This information is updated periodically as checks are performed against backends.
| -| `ssl_commonname` | `string` | The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
| -| `check_body` | `string` | This value must be present in the response body of the check in order for it to pass. If this value is not present in the response body of a check request, the backend is considered to be down.
| -| `cipher_suite` | `string` | What ciphers to use for SSL connections served by this NodeBalancer.

* `legacy` is considered insecure and should only be used if necessary.
| -| `ssl_cert` | `string` | The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL
certificate and Certificate Authority chain) that should be served on this
NodeBalancerConfig's port.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI).

[Diffie-Hellman Parameters](/docs/products/networking/nodebalancers/guides/ssl-termination/#diffie-hellman-parameters) can be included in this value to enable forward secrecy.

The contents of this field will not be shown in any responses that display
the NodeBalancerConfig. Instead, `<REDACTED>` will be printed where the field
appears.

The read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig
response are automatically derived from your certificate. Please refer to these fields to
verify that the appropriate certificate was assigned to your NodeBalancerConfig.
| -| `ssl_key` | `string` | The PEM-formatted private key for the SSL certificate set in the `ssl_cert` field.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI).

The contents of this field will not be shown in any responses that display
the NodeBalancerConfig. Instead, `<REDACTED>` will be printed where the field
appears.

The read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig
response are automatically derived from your certificate. Please refer to these fields to
verify that the appropriate certificate was assigned to your NodeBalancerConfig.
| -| `check_path` | `string` | The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.
| +| | `integer` | This config's unique ID | +| | `string` | What algorithm this NodeBalancer should use for routing traffic to backends.
| +| | `string` | The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down.
* If `none` no check is performed.
* `connection` requires only a connection to the backend to succeed.
* `http` and `http_body` rely on the backend serving HTTP, and that
the response returned matches what is expected.
| +| | `integer` | How many times to attempt a check before considering a backend to be down.
| +| | `string` | This value must be present in the response body of the check in order for it to pass. If this value is not present in the response body of a check request, the backend is considered to be down.
| +| | `integer` | How often, in seconds, to check that backends are up and serving requests.

Must be greater than `check_timeout`.
| +| | `boolean` | If true, any response from this backend with a `5xx` status code will be enough for it to be considered unhealthy and taken out of rotation.
| +| | `string` | The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.
| +| | `integer` | How long, in seconds, to wait for a check attempt before considering it failed.

Must be less than `check_interval`.
| +| | `string` | What ciphers to use for SSL connections served by this NodeBalancer.

* `legacy` is considered insecure and should only be used if necessary.
| +| | `integer` | The ID for the NodeBalancer this config belongs to.
| +| | `object` | A structure containing information about the health of the backends for this port. This information is updated periodically as checks are performed against backends.
| +| | `integer` | The port this Config is for. These values must be unique across configs on a single NodeBalancer (you can't have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443.
| +| | `string` | The protocol this port is configured to serve.

* The `http` and `tcp` protocols do not support `ssl_cert` and `ssl_key`.

* The `https` protocol is mutually required with `ssl_cert` and `ssl_key`.

Review our guide on [Available Protocols](/docs/products/networking/nodebalancers/guides/protocols/) for information on protocol features.
| +| | `string` | ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices. This information would be lost otherwise. Backend devices must be configured to work with ProxyProtocol if enabled.

* If ommited, or set to `none`, the NodeBalancer doesn't send any auxilary data over TCP connections. This is the default.
* If set to `v1`, the human-readable header format (Version 1) is used. Requires `tcp` protocol.
* If set to `v2`, the binary header format (Version 2) is used. Requires `tcp` protocol.
| +| | `string` | The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL
certificate and Certificate Authority chain) that should be served on this
NodeBalancerConfig's port.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI).

[Diffie-Hellman Parameters](/docs/products/networking/nodebalancers/guides/ssl-termination/#diffie-hellman-parameters) can be included in this value to enable forward secrecy.

The contents of this field will not be shown in any responses that display
the NodeBalancerConfig. Instead, `<REDACTED>` will be printed where the field
appears.

The read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig
response are automatically derived from your certificate. Please refer to these fields to
verify that the appropriate certificate was assigned to your NodeBalancerConfig.
| +| | `string` | The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
| +| | `string` | The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
| +| | `string` | The PEM-formatted private key for the SSL certificate set in the `ssl_cert` field.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI).

The contents of this field will not be shown in any responses that display
the NodeBalancerConfig. Instead, `<REDACTED>` will be printed where the field
appears.

The read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig
response are automatically derived from your certificate. Please refer to these fields to
verify that the appropriate certificate was assigned to your NodeBalancerConfig.
| +| | `string` | Controls how session stickiness is handled on this port.
* If set to `none` connections will always be assigned a backend based on the algorithm configured.
* If set to `table` sessions from the same remote address will be routed to the same
backend.

* For HTTP or HTTPS clients, `http_cookie` allows sessions to be
routed to the same backend based on a cookie set by the NodeBalancer.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getNodeBalancerConfig` | `SELECT` | `configId, nodeBalancerId` | Returns configuration information for a single port of this NodeBalancer.
| -| `getNodeBalancerConfigs` | `SELECT` | `nodeBalancerId` | Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.

For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.
| -| `createNodeBalancerConfig` | `INSERT` | `nodeBalancerId` | Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests.
| -| `deleteNodeBalancerConfig` | `DELETE` | `configId, nodeBalancerId` | Deletes the Config for a port of this NodeBalancer.

**This cannot be undone.**

Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed.
| -| `_getNodeBalancerConfig` | `EXEC` | `configId, nodeBalancerId` | Returns configuration information for a single port of this NodeBalancer.
| -| `_getNodeBalancerConfigs` | `EXEC` | `nodeBalancerId` | Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.

For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.
| -| `rebuildNodeBalancerConfig` | `EXEC` | `configId, nodeBalancerId` | Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.

Use this command to update a NodeBalancer's Config and Nodes with a single request.
| -| `updateNodeBalancerConfig` | `EXEC` | `configId, nodeBalancerId` | Updates the configuration for a single port on a NodeBalancer.
| +| | `SELECT` | | Returns configuration information for a single port of this NodeBalancer.
| +| | `SELECT` | | Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.

For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.
| +| | `INSERT` | | Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests.
| +| | `DELETE` | | Deletes the Config for a port of this NodeBalancer.

**This cannot be undone.**

Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed.
| +| | `EXEC` | | Returns configuration information for a single port of this NodeBalancer.
| +| | `EXEC` | | Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.

For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.
| +| | `EXEC` | | Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.

Use this command to update a NodeBalancer's Config and Nodes with a single request.
| +| | `EXEC` | | Updates the configuration for a single port on a NodeBalancer.
| diff --git a/docs/linode-docs/providers/linode/nodebalancers/configs_nodes/index.md b/docs/linode-docs/providers/linode/nodebalancers/configs_nodes/index.md index 1f73cbfa38..a37f43781f 100644 --- a/docs/linode-docs/providers/linode/nodebalancers/configs_nodes/index.md +++ b/docs/linode-docs/providers/linode/nodebalancers/configs_nodes/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfigs_nodes
TypeResource
Idlinode.nodebalancers.configs_nodes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This node's unique ID. | -| `mode` | `string` | The mode this NodeBalancer should use when sending traffic to this backend.
* If set to `accept` this backend is accepting traffic.
* If set to `reject` this backend will not receive traffic.
* If set to `drain` this backend will not receive _new_ traffic, but connections already
pinned to it will continue to be routed to it.

* If set to `backup`, this backend will only receive traffic if all `accept` nodes
are down.
| -| `nodebalancer_id` | `integer` | The NodeBalancer ID that this Node belongs to.
| -| `status` | `string` | The current status of this node, based on the configured checks of its NodeBalancer Config.
| -| `weight` | `integer` | Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.
| -| `address` | `string` | The private IP Address where this backend can be reached. This _must_ be a private IP address.
| -| `config_id` | `integer` | The NodeBalancer Config ID that this Node belongs to.
| -| `label` | `string` | The label for this node. This is for display purposes only.
| +| | `integer` | This node's unique ID. | +| | `string` | The private IP Address where this backend can be reached. This _must_ be a private IP address.
| +| | `integer` | The NodeBalancer Config ID that this Node belongs to.
| +| | `string` | The label for this node. This is for display purposes only.
| +| | `string` | The mode this NodeBalancer should use when sending traffic to this backend.
* If set to `accept` this backend is accepting traffic.
* If set to `reject` this backend will not receive traffic.
* If set to `drain` this backend will not receive _new_ traffic, but connections already
pinned to it will continue to be routed to it.

* If set to `backup`, this backend will only receive traffic if all `accept` nodes
are down.
| +| | `integer` | The NodeBalancer ID that this Node belongs to.
| +| | `string` | The current status of this node, based on the configured checks of its NodeBalancer Config.
| +| | `integer` | Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getNodeBalancerConfigNodes` | `SELECT` | `configId, nodeBalancerId` | Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
| -| `getNodeBalancerNode` | `SELECT` | `configId, nodeBalancerId, nodeId` | Returns information about a single Node, a backend for this NodeBalancer's configured port.
| -| `createNodeBalancerNode` | `INSERT` | `configId, nodeBalancerId, data__address, data__label` | Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status.
| -| `deleteNodeBalancerConfigNode` | `DELETE` | `configId, nodeBalancerId, nodeId` | Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer.

This does not change or remove the Linode whose address was used in the creation of this Node.
| -| `_getNodeBalancerConfigNodes` | `EXEC` | `configId, nodeBalancerId` | Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
| -| `_getNodeBalancerNode` | `EXEC` | `configId, nodeBalancerId, nodeId` | Returns information about a single Node, a backend for this NodeBalancer's configured port.
| -| `updateNodeBalancerNode` | `EXEC` | `configId, nodeBalancerId, nodeId` | Updates information about a Node, a backend for this NodeBalancer's configured port.
| +| | `SELECT` | | Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
| +| | `SELECT` | | Returns information about a single Node, a backend for this NodeBalancer's configured port.
| +| | `INSERT` | | Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status.
| +| | `DELETE` | | Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer.

This does not change or remove the Linode whose address was used in the creation of this Node.
| +| | `EXEC` | | Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
| +| | `EXEC` | | Returns information about a single Node, a backend for this NodeBalancer's configured port.
| +| | `EXEC` | | Updates information about a Node, a backend for this NodeBalancer's configured port.
| diff --git a/docs/linode-docs/providers/linode/nodebalancers/index.md b/docs/linode-docs/providers/linode/nodebalancers/index.md index e10f07ccdf..5ff487e211 100644 --- a/docs/linode-docs/providers/linode/nodebalancers/index.md +++ b/docs/linode-docs/providers/linode/nodebalancers/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Nodebalancers :::info Service Summary diff --git a/docs/linode-docs/providers/linode/nodebalancers/nodebalancers/index.md b/docs/linode-docs/providers/linode/nodebalancers/nodebalancers/index.md index e77bedefe5..2f08b95a46 100644 --- a/docs/linode-docs/providers/linode/nodebalancers/nodebalancers/index.md +++ b/docs/linode-docs/providers/linode/nodebalancers/nodebalancers/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenodebalancers
TypeResource
Idlinode.nodebalancers.nodebalancers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This NodeBalancer's unique ID.
| -| `label` | `string` | This NodeBalancer's label. These must be unique on your Account.
| -| `client_conn_throttle` | `integer` | Throttle connections per second. Set to 0 (zero) to disable throttling.
| -| `created` | `string` | When this NodeBalancer was created.
| -| `ipv4` | `string` | This NodeBalancer's public IPv4 address.
| -| `region` | `string` | The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
| -| `transfer` | `object` | Information about the amount of transfer this NodeBalancer has had so far this month.
| -| `tags` | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| -| `hostname` | `string` | This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
| -| `ipv6` | `string` | This NodeBalancer's public IPv6 address.
| -| `updated` | `string` | When this NodeBalancer was last updated.
| +| | `integer` | This NodeBalancer's unique ID.
| +| | `integer` | Throttle connections per second. Set to 0 (zero) to disable throttling.
| +| | `string` | When this NodeBalancer was created.
| +| | `string` | This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
| +| | `string` | This NodeBalancer's public IPv4 address.
| +| | `string` | This NodeBalancer's public IPv6 address.
| +| | `string` | This NodeBalancer's label. These must be unique on your Account.
| +| | `string` | The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
| +| | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| +| | `object` | Information about the amount of transfer this NodeBalancer has had so far this month.
| +| | `string` | When this NodeBalancer was last updated.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getNodeBalancer` | `SELECT` | `nodeBalancerId` | Returns a single NodeBalancer you can access.
| -| `getNodeBalancers` | `SELECT` | | Returns a paginated list of NodeBalancers you have access to.
| -| `createNodeBalancer` | `INSERT` | `data__region` | Creates a NodeBalancer in the requested Region.

NodeBalancers require a port Config with at least one backend Node to start serving requests.

When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Config Create](/docs/api/nodebalancers/#config-create) and [Node Create](/docs/api/nodebalancers/#node-create) commands.
| -| `deleteNodeBalancer` | `DELETE` | `nodeBalancerId` | Deletes a NodeBalancer.

**This is a destructive action and cannot be undone.**

Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.
| -| `_getNodeBalancer` | `EXEC` | `nodeBalancerId` | Returns a single NodeBalancer you can access.
| -| `_getNodeBalancers` | `EXEC` | | Returns a paginated list of NodeBalancers you have access to.
| -| `updateNodeBalancer` | `EXEC` | `nodeBalancerId` | Updates information about a NodeBalancer you can access.
| +| | `SELECT` | | Returns a single NodeBalancer you can access.
| +| | `SELECT` | | Returns a paginated list of NodeBalancers you have access to.
| +| | `INSERT` | | Creates a NodeBalancer in the requested Region.

NodeBalancers require a port Config with at least one backend Node to start serving requests.

When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Config Create](/docs/api/nodebalancers/#config-create) and [Node Create](/docs/api/nodebalancers/#node-create) commands.
| +| | `DELETE` | | Deletes a NodeBalancer.

**This is a destructive action and cannot be undone.**

Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.
| +| | `EXEC` | | Returns a single NodeBalancer you can access.
| +| | `EXEC` | | Returns a paginated list of NodeBalancers you have access to.
| +| | `EXEC` | | Updates information about a NodeBalancer you can access.
| diff --git a/docs/linode-docs/providers/linode/nodebalancers/stats/index.md b/docs/linode-docs/providers/linode/nodebalancers/stats/index.md index b92ef28277..28e2c3052f 100644 --- a/docs/linode-docs/providers/linode/nodebalancers/stats/index.md +++ b/docs/linode-docs/providers/linode/nodebalancers/stats/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestats
TypeResource
Idlinode.nodebalancers.stats
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `connections` | `array` | An array of key/value pairs representing unix timestamp and reading for connections to this NodeBalancer.
| -| `traffic` | `object` | Traffic statistics for this NodeBalancer.
| +| | `array` | An array of key/value pairs representing unix timestamp and reading for connections to this NodeBalancer.
| +| | `object` | Traffic statistics for this NodeBalancer.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_nodebalancers__nodeBalancerId_stats` | `SELECT` | `nodeBalancerId` | -| `_get_nodebalancers__nodeBalancerId_stats` | `EXEC` | `nodeBalancerId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/object_storage/buckets/index.md b/docs/linode-docs/providers/linode/object_storage/buckets/index.md index 4a554e72b3..00678d09f9 100644 --- a/docs/linode-docs/providers/linode/object_storage/buckets/index.md +++ b/docs/linode-docs/providers/linode/object_storage/buckets/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuckets
TypeResource
Idlinode.object_storage.buckets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cluster` | `string` | The ID of the Object Storage Cluster this bucket is in. | -| `created` | `string` | When this bucket was created. | -| `hostname` | `string` | The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.
| -| `label` | `string` | The name of this bucket. | -| `objects` | `integer` | The number of objects stored in this bucket.
| -| `size` | `integer` | The size of the bucket in bytes. | +| | `string` | The ID of the Object Storage Cluster this bucket is in. | +| | `string` | When this bucket was created. | +| | `string` | The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.
| +| | `string` | The name of this bucket. | +| | `integer` | The number of objects stored in this bucket.
| +| | `integer` | The size of the bucket in bytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getObjectStorageBucket` | `SELECT` | `bucket, clusterId` | Returns a single Object Storage Bucket.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| -| `getObjectStorageBucketinCluster` | `SELECT` | `clusterId` | Returns a list of Buckets in this cluster belonging to this Account.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| -| `getObjectStorageBuckets` | `SELECT` | | Returns a paginated list of all Object Storage Buckets that you own.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) directly.
| -| `createObjectStorageBucket` | `INSERT` | `data__cluster, data__label` | Creates an Object Storage Bucket in the specified cluster.

Accounts with negative balances cannot access this command.

If the bucket already exists and is owned by you, this endpoint returns a `200` response with that bucket as if it had just been created.

This endpoint is available for convenience. It is recommended that instead you use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) directly.
| -| `deleteObjectStorageBucket` | `DELETE` | `bucket, clusterId` | Removes a single bucket.

Bucket objects must be removed prior to removing the bucket. While buckets containing objects _may_ be
deleted using the [s3cmd command-line tool](/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), such operations
can fail if the bucket contains too many objects. The recommended
way to empty large buckets is to use the [S3 API to configure lifecycle policies](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#) that
remove all objects, then delete the bucket.

This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) directly.
| -| `_getObjectStorageBucket` | `EXEC` | `bucket, clusterId` | Returns a single Object Storage Bucket.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| -| `_getObjectStorageBucketinCluster` | `EXEC` | `clusterId` | Returns a list of Buckets in this cluster belonging to this Account.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| -| `_getObjectStorageBuckets` | `EXEC` | | Returns a paginated list of all Object Storage Buckets that you own.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) directly.
| -| `_viewObjectStorageBucketACL` | `EXEC` | `bucket, clusterId` | View an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) directly.
| -| `modifyObjectStorageBucketAccess` | `EXEC` | `bucket, clusterId` | Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.
Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs.


For more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.
| -| `updateObjectStorageBucketACL` | `EXEC` | `bucket, clusterId, data__acl, data__name` | Update an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) directly.
| -| `updateObjectStorageBucketAccess` | `EXEC` | `bucket, clusterId` | Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.
Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs.


For more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.
| -| `viewObjectStorageBucketACL` | `EXEC` | `bucket, clusterId` | View an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) directly.
| +| | `SELECT` | | Returns a single Object Storage Bucket.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| +| | `SELECT` | | Returns a list of Buckets in this cluster belonging to this Account.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| +| | `SELECT` | | Returns a paginated list of all Object Storage Buckets that you own.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) directly.
| +| | `INSERT` | | Creates an Object Storage Bucket in the specified cluster.

Accounts with negative balances cannot access this command.

If the bucket already exists and is owned by you, this endpoint returns a `200` response with that bucket as if it had just been created.

This endpoint is available for convenience. It is recommended that instead you use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) directly.
| +| | `DELETE` | | Removes a single bucket.

Bucket objects must be removed prior to removing the bucket. While buckets containing objects _may_ be
deleted using the [s3cmd command-line tool](/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), such operations
can fail if the bucket contains too many objects. The recommended
way to empty large buckets is to use the [S3 API to configure lifecycle policies](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#) that
remove all objects, then delete the bucket.

This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) directly.
| +| | `EXEC` | | Returns a single Object Storage Bucket.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| +| | `EXEC` | | Returns a list of Buckets in this cluster belonging to this Account.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.
| +| | `EXEC` | | Returns a paginated list of all Object Storage Buckets that you own.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) directly.
| +| | `EXEC` | | View an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) directly.
| +| | `EXEC` | | Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.
Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs.


For more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.
| +| | `EXEC` | | Update an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) directly.
| +| | `EXEC` | | Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.
Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs.


For more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.
| +| | `EXEC` | | View an Object's configured Access Control List (ACL) in this Object Storage bucket.
ACLs define who can access your buckets and objects and specify the level of access
granted to those users.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) directly.
| diff --git a/docs/linode-docs/providers/linode/object_storage/buckets_object_list/index.md b/docs/linode-docs/providers/linode/object_storage/buckets_object_list/index.md index 4c27f48f14..b92da7708b 100644 --- a/docs/linode-docs/providers/linode/object_storage/buckets_object_list/index.md +++ b/docs/linode-docs/providers/linode/object_storage/buckets_object_list/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuckets_object_list
TypeResource
Idlinode.object_storage.buckets_object_list
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of this object or prefix.
| -| `next_marker` | `string` | Returns the value you should pass to the `marker` query parameter to get the next page of objects. If there is no next page, `null` will be returned.
| -| `owner` | `string` | The owner of this object, as a UUID. `null` if this object represents a prefix.
| -| `size` | `integer` | The size of this object, in bytes. `null` if this object represents a prefix.
| -| `etag` | `string` | An MD-5 hash of the object. `null` if this object represents a prefix.
| -| `is_truncated` | `boolean` | Designates if there is another page of bucket objects. | -| `last_modified` | `string` | The date and time this object was last modified. `null` if this object represents a prefix.
| +| | `string` | The name of this object or prefix.
| +| | `string` | An MD-5 hash of the object. `null` if this object represents a prefix.
| +| | `boolean` | Designates if there is another page of bucket objects. | +| | `string` | The date and time this object was last modified. `null` if this object represents a prefix.
| +| | `string` | Returns the value you should pass to the `marker` query parameter to get the next page of objects. If there is no next page, `null` will be returned.
| +| | `string` | The owner of this object, as a UUID. `null` if this object represents a prefix.
| +| | `integer` | The size of this object, in bytes. `null` if this object represents a prefix.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getObjectStorageBucketContent` | `SELECT` | `bucket, clusterId` | -| `_getObjectStorageBucketContent` | `EXEC` | `bucket, clusterId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/object_storage/buckets_object_url/index.md b/docs/linode-docs/providers/linode/object_storage/buckets_object_url/index.md index a5cb807891..bdf4478ae3 100644 --- a/docs/linode-docs/providers/linode/object_storage/buckets_object_url/index.md +++ b/docs/linode-docs/providers/linode/object_storage/buckets_object_url/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuckets_object_url
TypeResource
Idlinode.object_storage.buckets_object_url
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createObjectStorageObjectURL` | `INSERT` | `bucket, clusterId, data__method, data__name` | +| | `INSERT` | | diff --git a/docs/linode-docs/providers/linode/object_storage/buckets_ssl/index.md b/docs/linode-docs/providers/linode/object_storage/buckets_ssl/index.md index 72a4ea8999..27217e896e 100644 --- a/docs/linode-docs/providers/linode/object_storage/buckets_ssl/index.md +++ b/docs/linode-docs/providers/linode/object_storage/buckets_ssl/index.md @@ -14,21 +14,24 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuckets_ssl
TypeResource
Idlinode.object_storage.buckets_ssl
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getObjectStorageSSL` | `SELECT` | `bucket, clusterId` | Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was
uploaded by an Account user.
| -| `createObjectStorageSSL` | `INSERT` | `bucket, clusterId, data__certificate, data__private_key` | Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS.
Your TLS/SSL certificate and private key are stored encrypted at rest.


To replace an expired certificate, [delete your current certificate](/docs/api/object-storage/#object-storage-tlsssl-cert-delete)
and upload a new one.
| -| `deleteObjectStorageSSL` | `DELETE` | `bucket, clusterId` | Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.
| -| `_getObjectStorageSSL` | `EXEC` | `bucket, clusterId` | Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was
uploaded by an Account user.
| +| | `SELECT` | | Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was
uploaded by an Account user.
| +| | `INSERT` | | Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS.
Your TLS/SSL certificate and private key are stored encrypted at rest.


To replace an expired certificate, [delete your current certificate](/docs/api/object-storage/#object-storage-tlsssl-cert-delete)
and upload a new one.
| +| | `DELETE` | | Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.
| +| | `EXEC` | | Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was
uploaded by an Account user.
| diff --git a/docs/linode-docs/providers/linode/object_storage/cancel/index.md b/docs/linode-docs/providers/linode/object_storage/cancel/index.md index 58c6edc7e0..4a788e0f70 100644 --- a/docs/linode-docs/providers/linode/object_storage/cancel/index.md +++ b/docs/linode-docs/providers/linode/object_storage/cancel/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecancel
TypeResource
Idlinode.object_storage.cancel
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `cancelObjectStorage` | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/object_storage/clusters/index.md b/docs/linode-docs/providers/linode/object_storage/clusters/index.md index 588ea83559..804453e351 100644 --- a/docs/linode-docs/providers/linode/object_storage/clusters/index.md +++ b/docs/linode-docs/providers/linode/object_storage/clusters/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclusters
TypeResource
Idlinode.object_storage.clusters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID for this cluster. | -| `region` | `string` | The region where this cluster is located. | -| `static_site_domain` | `string` | The base URL for this cluster used when hosting static sites. | -| `status` | `string` | This cluster's status. | -| `domain` | `string` | The base URL for this cluster, used for connecting with third-party clients. | +| | `string` | The unique ID for this cluster. | +| | `string` | The base URL for this cluster, used for connecting with third-party clients. | +| | `string` | The region where this cluster is located. | +| | `string` | The base URL for this cluster used when hosting static sites. | +| | `string` | This cluster's status. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getObjectStorageCluster` | `SELECT` | `clusterId` | Returns a single Object Storage Cluster.
| -| `getObjectStorageClusters` | `SELECT` | | Returns a paginated list of Object Storage Clusters that are available for
use. Users can connect to the clusters with third party clients to create buckets
and upload objects.
| -| `_getObjectStorageCluster` | `EXEC` | `clusterId` | Returns a single Object Storage Cluster.
| -| `_getObjectStorageClusters` | `EXEC` | | Returns a paginated list of Object Storage Clusters that are available for
use. Users can connect to the clusters with third party clients to create buckets
and upload objects.
| +| | `SELECT` | | Returns a single Object Storage Cluster.
| +| | `SELECT` | | Returns a paginated list of Object Storage Clusters that are available for
use. Users can connect to the clusters with third party clients to create buckets
and upload objects.
| +| | `EXEC` | | Returns a single Object Storage Cluster.
| +| | `EXEC` | | Returns a paginated list of Object Storage Clusters that are available for
use. Users can connect to the clusters with third party clients to create buckets
and upload objects.
| diff --git a/docs/linode-docs/providers/linode/object_storage/index.md b/docs/linode-docs/providers/linode/object_storage/index.md index 14989e4607..9d66070f1e 100644 --- a/docs/linode-docs/providers/linode/object_storage/index.md +++ b/docs/linode-docs/providers/linode/object_storage/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Object Storage :::info Service Summary diff --git a/docs/linode-docs/providers/linode/object_storage/keys/index.md b/docs/linode-docs/providers/linode/object_storage/keys/index.md index ec1c47af67..f6554a351c 100644 --- a/docs/linode-docs/providers/linode/object_storage/keys/index.md +++ b/docs/linode-docs/providers/linode/object_storage/keys/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekeys
TypeResource
Idlinode.object_storage.keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This keypair's unique ID | -| `label` | `string` | The label given to this key. For display purposes only. | -| `limited` | `boolean` | Whether or not this key is a limited access key. Will return `false` if this key grants full access to all buckets on the user's account. | -| `secret_key` | `string` | This keypair's secret key. Only returned on key creation. | -| `access_key` | `string` | This keypair's access key. This is not secret. | -| `bucket_access` | `array` | Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key's access to only the bucket(s) declared in this array and define their bucket-level permissions.


Limited Access Keys can:

* [list all buckets](/docs/api/object-storage/#object-storage-buckets-list) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket.


* [create new buckets](/docs/api/object-storage/#object-storage-bucket-create), but do not have any access to the buckets it creates, unless explicitly given access to them.


**Note:** You can create an Object Storage Limited Access Key without access to any buckets.
This is achieved by sending a request with an empty `bucket_access` array.


**Note:** If this field is omitted, a regular unlimited access key is issued.
| +| | `integer` | This keypair's unique ID | +| | `string` | This keypair's access key. This is not secret. | +| | `array` | Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key's access to only the bucket(s) declared in this array and define their bucket-level permissions.


Limited Access Keys can:

* [list all buckets](/docs/api/object-storage/#object-storage-buckets-list) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket.


* [create new buckets](/docs/api/object-storage/#object-storage-bucket-create), but do not have any access to the buckets it creates, unless explicitly given access to them.


**Note:** You can create an Object Storage Limited Access Key without access to any buckets.
This is achieved by sending a request with an empty `bucket_access` array.


**Note:** If this field is omitted, a regular unlimited access key is issued.
| +| | `string` | The label given to this key. For display purposes only. | +| | `boolean` | Whether or not this key is a limited access key. Will return `false` if this key grants full access to all buckets on the user's account. | +| | `string` | This keypair's secret key. Only returned on key creation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getObjectStorageKey` | `SELECT` | `keyId` | Returns a single Object Storage Key provisioned for your account.
| -| `getObjectStorageKeys` | `SELECT` | | Returns a paginated list of Object Storage Keys for authenticating to
the Object Storage S3 API.
| -| `createObjectStorageKeys` | `INSERT` | | Provisions a new Object Storage Key on your account.

Accounts with negative balances cannot access this command.

* To create a Limited Access Key with specific permissions, send a `bucket_access` array.

* To create a Limited Access Key without access to any buckets, send an empty `bucket_access` array.

* To create an Access Key with unlimited access to all clusters and all buckets, omit the `bucket_access` array.
| -| `deleteObjectStorageKey` | `DELETE` | `keyId` | Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.
| -| `_getObjectStorageKey` | `EXEC` | `keyId` | Returns a single Object Storage Key provisioned for your account.
| -| `_getObjectStorageKeys` | `EXEC` | | Returns a paginated list of Object Storage Keys for authenticating to
the Object Storage S3 API.
| -| `updateObjectStorageKey` | `EXEC` | `keyId` | Updates an Object Storage Key on your account.
| +| | `SELECT` | | Returns a single Object Storage Key provisioned for your account.
| +| | `SELECT` | | Returns a paginated list of Object Storage Keys for authenticating to
the Object Storage S3 API.
| +| | `INSERT` | | Provisions a new Object Storage Key on your account.

Accounts with negative balances cannot access this command.

* To create a Limited Access Key with specific permissions, send a `bucket_access` array.

* To create a Limited Access Key without access to any buckets, send an empty `bucket_access` array.

* To create an Access Key with unlimited access to all clusters and all buckets, omit the `bucket_access` array.
| +| | `DELETE` | | Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.
| +| | `EXEC` | | Returns a single Object Storage Key provisioned for your account.
| +| | `EXEC` | | Returns a paginated list of Object Storage Keys for authenticating to
the Object Storage S3 API.
| +| | `EXEC` | | Updates an Object Storage Key on your account.
| diff --git a/docs/linode-docs/providers/linode/object_storage/transfer/index.md b/docs/linode-docs/providers/linode/object_storage/transfer/index.md index 48ff016f7f..703c05600a 100644 --- a/docs/linode-docs/providers/linode/object_storage/transfer/index.md +++ b/docs/linode-docs/providers/linode/object_storage/transfer/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametransfer
TypeResource
Idlinode.object_storage.transfer
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getObjectStorageTransfer` | `SELECT` | | -| `_getObjectStorageTransfer` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/profile/apps/index.md b/docs/linode-docs/providers/linode/profile/apps/index.md index c5a762b7ef..442a2b651a 100644 --- a/docs/linode-docs/providers/linode/profile/apps/index.md +++ b/docs/linode-docs/providers/linode/profile/apps/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapps
TypeResource
Idlinode.profile.apps
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This authorization's ID, used for revoking access.
| -| `expiry` | `string` | When the app's access to your account expires. If `null`, the app's access must be revoked manually.
| -| `label` | `string` | The name of the application you've authorized.
| -| `scopes` | `string` | The OAuth scopes this app was authorized with. This defines what parts of your Account the app is allowed to access.
| -| `thumbnail_url` | `string` | The URL at which this app's thumbnail may be accessed.
| -| `website` | `string` | The website where you can get more information about this app.
| -| `created` | `string` | When this app was authorized. | +| | `integer` | This authorization's ID, used for revoking access.
| +| | `string` | When this app was authorized. | +| | `string` | When the app's access to your account expires. If `null`, the app's access must be revoked manually.
| +| | `string` | The name of the application you've authorized.
| +| | `string` | The OAuth scopes this app was authorized with. This defines what parts of your Account the app is allowed to access.
| +| | `string` | The URL at which this app's thumbnail may be accessed.
| +| | `string` | The website where you can get more information about this app.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getProfileApp` | `SELECT` | `appId` | Returns information about a single app you've authorized to access your Account.
| -| `getProfileApps` | `SELECT` | | This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.
| -| `deleteProfileApp` | `DELETE` | `appId` | Expires this app token. This token may no longer be used to access your Account.
| -| `_getProfileApp` | `EXEC` | `appId` | Returns information about a single app you've authorized to access your Account.
| -| `_getProfileApps` | `EXEC` | | This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.
| +| | `SELECT` | | Returns information about a single app you've authorized to access your Account.
| +| | `SELECT` | | This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.
| +| | `DELETE` | | Expires this app token. This token may no longer be used to access your Account.
| +| | `EXEC` | | Returns information about a single app you've authorized to access your Account.
| +| | `EXEC` | | This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.
| diff --git a/docs/linode-docs/providers/linode/profile/devices/index.md b/docs/linode-docs/providers/linode/profile/devices/index.md index c19367b850..31e614c254 100644 --- a/docs/linode-docs/providers/linode/profile/devices/index.md +++ b/docs/linode-docs/providers/linode/profile/devices/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedevices
TypeResource
Idlinode.profile.devices
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID for this TrustedDevice | -| `expiry` | `string` | When this TrustedDevice session expires. Sessions typically last 30 days.
| -| `last_authenticated` | `string` | The last time this TrustedDevice was successfully used to authenticate to <a target="_top" href="https://login.linode.com">login.linode.com</a>.
| -| `last_remote_addr` | `string` | The last IP Address to successfully authenticate with this TrustedDevice.
| -| `user_agent` | `string` | The User Agent of the browser that created this TrustedDevice session.
| -| `created` | `string` | When this Remember Me session was started. This corresponds to the time of login with the "Remember Me" box checked.
| +| | `integer` | The unique ID for this TrustedDevice | +| | `string` | When this Remember Me session was started. This corresponds to the time of login with the "Remember Me" box checked.
| +| | `string` | When this TrustedDevice session expires. Sessions typically last 30 days.
| +| | `string` | The last time this TrustedDevice was successfully used to authenticate to <a target="_top" href="https://login.linode.com">login.linode.com</a>.
| +| | `string` | The last IP Address to successfully authenticate with this TrustedDevice.
| +| | `string` | The User Agent of the browser that created this TrustedDevice session.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDevices` | `SELECT` | | Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.
| -| `getTrustedDevice` | `SELECT` | `deviceId` | Returns a single active TrustedDevice for your User.
| -| `_getDevices` | `EXEC` | | Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.
| -| `_getTrustedDevice` | `EXEC` | `deviceId` | Returns a single active TrustedDevice for your User.
| -| `revokeTrustedDevice` | `EXEC` | `deviceId` | Revoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account.
| +| | `SELECT` | | Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.
| +| | `SELECT` | | Returns a single active TrustedDevice for your User.
| +| | `EXEC` | | Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.
| +| | `EXEC` | | Returns a single active TrustedDevice for your User.
| +| | `EXEC` | | Revoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account.
| diff --git a/docs/linode-docs/providers/linode/profile/grants/index.md b/docs/linode-docs/providers/linode/profile/grants/index.md index c3039893e0..db511623e6 100644 --- a/docs/linode-docs/providers/linode/profile/grants/index.md +++ b/docs/linode-docs/providers/linode/profile/grants/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegrants
TypeResource
Idlinode.profile.grants
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `_getProfileGrants` | `EXEC` | | -| `getProfileGrants` | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/profile/index.md b/docs/linode-docs/providers/linode/profile/index.md index fd24728be8..981f6745ba 100644 --- a/docs/linode-docs/providers/linode/profile/index.md +++ b/docs/linode-docs/providers/linode/profile/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Profile :::info Service Summary diff --git a/docs/linode-docs/providers/linode/profile/logins/index.md b/docs/linode-docs/providers/linode/profile/logins/index.md index 61d84fac5d..341f1e36c8 100644 --- a/docs/linode-docs/providers/linode/profile/logins/index.md +++ b/docs/linode-docs/providers/linode/profile/logins/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelogins
TypeResource
Idlinode.profile.logins
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this login object.
| -| `ip` | `string` | The remote IP address that requested the login.
| -| `restricted` | `boolean` | True if the User that attempted the login was a restricted User, false otherwise.
| -| `status` | `string` | Whether the login attempt succeeded or failed.
| -| `username` | `string` | The username of the User that attempted the login.
| -| `datetime` | `string` | When the login was initiated.
| +| | `integer` | The unique ID of this login object.
| +| | `string` | When the login was initiated.
| +| | `string` | The remote IP address that requested the login.
| +| | `boolean` | True if the User that attempted the login was a restricted User, false otherwise.
| +| | `string` | Whether the login attempt succeeded or failed.
| +| | `string` | The username of the User that attempted the login.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getProfileLogin` | `SELECT` | `loginId` | Returns a login object displaying information about a successful account login from this user.
| -| `getProfileLogins` | `SELECT` | | Returns a collection of successful account logins from this user during the last 90 days.
| -| `_getProfileLogin` | `EXEC` | `loginId` | Returns a login object displaying information about a successful account login from this user.
| -| `_getProfileLogins` | `EXEC` | | Returns a collection of successful account logins from this user during the last 90 days.
| +| | `SELECT` | | Returns a login object displaying information about a successful account login from this user.
| +| | `SELECT` | | Returns a collection of successful account logins from this user during the last 90 days.
| +| | `EXEC` | | Returns a login object displaying information about a successful account login from this user.
| +| | `EXEC` | | Returns a collection of successful account logins from this user during the last 90 days.
| diff --git a/docs/linode-docs/providers/linode/profile/phone_number/index.md b/docs/linode-docs/providers/linode/profile/phone_number/index.md index 445b39427e..a124af4399 100644 --- a/docs/linode-docs/providers/linode/profile/phone_number/index.md +++ b/docs/linode-docs/providers/linode/profile/phone_number/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namephone_number
TypeResource
Idlinode.profile.phone_number
Id
## Fields @@ -29,6 +32,6 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `deleteProfilePhoneNumber` | `DELETE` | | Delete the verified phone number for the User making this request.

Use this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
| -| `postProfilePhoneNumber` | `EXEC` | `data__iso_code, data__phone_number` | Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.

* By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.

* Verification codes are valid for 10 minutes after they are sent.

* Subsequent requests made prior to code expiration result in sending the same code.

Once a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
| -| `postProfilePhoneNumberVerify` | `EXEC` | `data__otp_code` | Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.

* Verification codes are valid for 10 minutes after they are sent.

* Only the same User that made the verification code request can use that code with this command.

Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
| +| | `DELETE` | | Delete the verified phone number for the User making this request.

Use this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
| +| | `EXEC` | | Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.

* By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.

* Verification codes are valid for 10 minutes after they are sent.

* Subsequent requests made prior to code expiration result in sending the same code.

Once a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
| +| | `EXEC` | | Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.

* Verification codes are valid for 10 minutes after they are sent.

* Only the same User that made the verification code request can use that code with this command.

Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
| diff --git a/docs/linode-docs/providers/linode/profile/preferences/index.md b/docs/linode-docs/providers/linode/profile/preferences/index.md index 4175dd7524..ba86b72336 100644 --- a/docs/linode-docs/providers/linode/profile/preferences/index.md +++ b/docs/linode-docs/providers/linode/profile/preferences/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepreferences
TypeResource
Idlinode.profile.preferences
Id
## Fields @@ -29,6 +32,6 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `_getUserPreferences` | `EXEC` | | View a list of user preferences tied to the OAuth client that generated
the token making the request. The user preferences endpoints allow
consumers of the API to store arbitrary JSON data, such as a user's font
size preference or preferred display name. User preferences are available
for each OAuth client registered to your account, and as such an account can
have multiple user preferences.
| -| `getUserPreferences` | `EXEC` | | View a list of user preferences tied to the OAuth client that generated
the token making the request. The user preferences endpoints allow
consumers of the API to store arbitrary JSON data, such as a user's font
size preference or preferred display name. User preferences are available
for each OAuth client registered to your account, and as such an account can
have multiple user preferences.
| -| `updateUserPreferences` | `EXEC` | | Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store.
| +| | `EXEC` | | View a list of user preferences tied to the OAuth client that generated
the token making the request. The user preferences endpoints allow
consumers of the API to store arbitrary JSON data, such as a user's font
size preference or preferred display name. User preferences are available
for each OAuth client registered to your account, and as such an account can
have multiple user preferences.
| +| | `EXEC` | | View a list of user preferences tied to the OAuth client that generated
the token making the request. The user preferences endpoints allow
consumers of the API to store arbitrary JSON data, such as a user's font
size preference or preferred display name. User preferences are available
for each OAuth client registered to your account, and as such an account can
have multiple user preferences.
| +| | `EXEC` | | Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store.
| diff --git a/docs/linode-docs/providers/linode/profile/profile/index.md b/docs/linode-docs/providers/linode/profile/profile/index.md index aa8e46cbca..742dc68864 100644 --- a/docs/linode-docs/providers/linode/profile/profile/index.md +++ b/docs/linode-docs/providers/linode/profile/profile/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprofile
TypeResource
Idlinode.profile.profile
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ip_whitelist_enabled` | `boolean` | If true, logins for your User will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.

If you disable this setting, you will not be able to re-enable it.
| -| `timezone` | `string` | The timezone you prefer to see times in. This is not used by the API directly. It is provided for the benefit of clients such as the Linode Cloud Manager and other clients built on the API. All times returned by the API are in UTC.
| -| `lish_auth_method` | `string` | The authentication methods that are allowed when connecting to [the Linode Shell (Lish)](/docs/guides/lish/).
* `keys_only` is the most secure if you intend to use Lish.
* `disabled` is recommended if you do not intend to use Lish at all.
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request to the [View Profile](/docs/api/profile/#profile-view) endpoint.
| -| `verified_phone_number` | `string` | The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.

`null` if this Profile has no verified phone number.
| -| `referrals` | `object` | Information about your status in our referral program.

This information becomes accessible after this Profile's Account has established at least $25.00 USD of total payments.
| -| `uid` | `integer` | Your unique ID in our system. This value will never change, and can safely be used to identify your User.
| -| `email_notifications` | `boolean` | If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.
| -| `username` | `string` | Your username, used for logging in to our system.
| -| `authentication_type` | `string` | This account's Cloud Manager authentication type. Authentication types are chosen through
Cloud Manager and authorized when logging into your account. These authentication types are either
the user's password (in conjunction with their username), or the name of their
indentity provider such as GitHub. For example, if a user:

- Has never used Third-Party Authentication, their authentication type will be `password`.
- Is using Third-Party Authentication, their authentication type will be the name of their Identity Provider (eg. `github`).
- Has used Third-Party Authentication and has since revoked it, their authentication type will be `password`.


**Note:** This functionality may not yet be available in Cloud Manager.
See the [Cloud Manager Changelog](/changelog/cloud-manager/) for the latest updates.
| -| `authorized_keys` | `array` | The list of SSH Keys authorized to use Lish for your User. This value is ignored if `lish_auth_method` is "disabled."
| -| `email` | `string` | Your email address. This address will be used for communication with Linode as necessary.
| -| `restricted` | `boolean` | If true, your User has restrictions on what can be accessed on your Account. To get details on what entities/actions you can access/perform, see [/profile/grants](/docs/api/profile/#grants-list).
| -| `two_factor_auth` | `boolean` | If true, logins from untrusted computers will require Two Factor Authentication. See [/profile/tfa-enable](/docs/api/profile/#two-factor-secret-create) to enable Two Factor Authentication.
| +| | `string` | This account's Cloud Manager authentication type. Authentication types are chosen through
Cloud Manager and authorized when logging into your account. These authentication types are either
the user's password (in conjunction with their username), or the name of their
indentity provider such as GitHub. For example, if a user:

- Has never used Third-Party Authentication, their authentication type will be `password`.
- Is using Third-Party Authentication, their authentication type will be the name of their Identity Provider (eg. `github`).
- Has used Third-Party Authentication and has since revoked it, their authentication type will be `password`.


**Note:** This functionality may not yet be available in Cloud Manager.
See the [Cloud Manager Changelog](/changelog/cloud-manager/) for the latest updates.
| +| | `array` | The list of SSH Keys authorized to use Lish for your User. This value is ignored if `lish_auth_method` is "disabled."
| +| | `string` | Your email address. This address will be used for communication with Linode as necessary.
| +| | `boolean` | If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.
| +| | `boolean` | If true, logins for your User will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.

If you disable this setting, you will not be able to re-enable it.
| +| | `string` | The authentication methods that are allowed when connecting to [the Linode Shell (Lish)](/docs/guides/lish/).
* `keys_only` is the most secure if you intend to use Lish.
* `disabled` is recommended if you do not intend to use Lish at all.
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request to the [View Profile](/docs/api/profile/#profile-view) endpoint.
| +| | `object` | Information about your status in our referral program.

This information becomes accessible after this Profile's Account has established at least $25.00 USD of total payments.
| +| | `boolean` | If true, your User has restrictions on what can be accessed on your Account. To get details on what entities/actions you can access/perform, see [/profile/grants](/docs/api/profile/#grants-list).
| +| | `string` | The timezone you prefer to see times in. This is not used by the API directly. It is provided for the benefit of clients such as the Linode Cloud Manager and other clients built on the API. All times returned by the API are in UTC.
| +| | `boolean` | If true, logins from untrusted computers will require Two Factor Authentication. See [/profile/tfa-enable](/docs/api/profile/#two-factor-secret-create) to enable Two Factor Authentication.
| +| | `integer` | Your unique ID in our system. This value will never change, and can safely be used to identify your User.
| +| | `string` | Your username, used for logging in to our system.
| +| | `string` | The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.

`null` if this Profile has no verified phone number.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getProfile` | `SELECT` | | Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.

This endpoint is always accessible, no matter what OAuth scopes the acting token has.
| -| `_getProfile` | `EXEC` | | Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.

This endpoint is always accessible, no matter what OAuth scopes the acting token has.
| -| `updateProfile` | `EXEC` | | Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope.
| +| | `SELECT` | | Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.

This endpoint is always accessible, no matter what OAuth scopes the acting token has.
| +| | `EXEC` | | Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.

This endpoint is always accessible, no matter what OAuth scopes the acting token has.
| +| | `EXEC` | | Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope.
| diff --git a/docs/linode-docs/providers/linode/profile/security_questions/index.md b/docs/linode-docs/providers/linode/profile/security_questions/index.md index 8003a363bc..90e0c2105a 100644 --- a/docs/linode-docs/providers/linode/profile/security_questions/index.md +++ b/docs/linode-docs/providers/linode/profile/security_questions/index.md @@ -14,20 +14,23 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesecurity_questions
TypeResource
Idlinode.profile.security_questions
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSecurityQuestions` | `SELECT` | | Returns a collection of security questions and their responses, if any, for your User Profile.
| -| `_getSecurityQuestions` | `EXEC` | | Returns a collection of security questions and their responses, if any, for your User Profile.
| -| `postSecurityQuestions` | `EXEC` | | Adds security question responses for your User.

Requires exactly three unique questions.

Previous responses are overwritten if answered or reset to `null` if unanswered.

**Note**: Security questions must be answered for your User prior to accessing the **Two Factor Secret Create** ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) command.
| +| | `SELECT` | | Returns a collection of security questions and their responses, if any, for your User Profile.
| +| | `EXEC` | | Returns a collection of security questions and their responses, if any, for your User Profile.
| +| | `EXEC` | | Adds security question responses for your User.

Requires exactly three unique questions.

Previous responses are overwritten if answered or reset to `null` if unanswered.

**Note**: Security questions must be answered for your User prior to accessing the **Two Factor Secret Create** ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) command.
| diff --git a/docs/linode-docs/providers/linode/profile/sshkeys/index.md b/docs/linode-docs/providers/linode/profile/sshkeys/index.md index 24341811b0..2b3e3708a4 100644 --- a/docs/linode-docs/providers/linode/profile/sshkeys/index.md +++ b/docs/linode-docs/providers/linode/profile/sshkeys/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesshkeys
TypeResource
Idlinode.profile.sshkeys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique identifier of an SSH Key object.
| -| `label` | `string` | A label for the SSH Key.
| -| `ssh_key` | `string` | The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

Accepted formats:
* ssh-dss
* ssh-rsa
* ecdsa-sha2-nistp
* ssh-ed25519
* sk-ecdsa-sha2-nistp256 (Akamai-specific)
| -| `created` | `string` | The date this key was added.
| +| | `integer` | The unique identifier of an SSH Key object.
| +| | `string` | The date this key was added.
| +| | `string` | A label for the SSH Key.
| +| | `string` | The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

Accepted formats:
* ssh-dss
* ssh-rsa
* ecdsa-sha2-nistp
* ssh-ed25519
* sk-ecdsa-sha2-nistp256 (Akamai-specific)
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSSHKey` | `SELECT` | `sshKeyId` | Returns a single SSH Key object identified by `id` that you have access to view.
| -| `getSSHKeys` | `SELECT` | | Returns a collection of SSH Keys you've added to your Profile.
| -| `addSSHKey` | `INSERT` | | Adds an SSH Key to your Account profile.
| -| `deleteSSHKey` | `DELETE` | `sshKeyId` | Deletes an SSH Key you have access to.

**Note:** deleting an SSH Key will *not* remove it from any Linode or Disk that was deployed with `authorized_keys`. In those cases, the keys must be manually deleted on the Linode or Disk. This endpoint will only delete the key's association from your Profile.
| -| `_getSSHKey` | `EXEC` | `sshKeyId` | Returns a single SSH Key object identified by `id` that you have access to view.
| -| `_getSSHKeys` | `EXEC` | | Returns a collection of SSH Keys you've added to your Profile.
| -| `updateSSHKey` | `EXEC` | `sshKeyId` | Updates an SSH Key that you have permission to `read_write`.

Only SSH key labels can be updated.
| +| | `SELECT` | | Returns a single SSH Key object identified by `id` that you have access to view.
| +| | `SELECT` | | Returns a collection of SSH Keys you've added to your Profile.
| +| | `INSERT` | | Adds an SSH Key to your Account profile.
| +| | `DELETE` | | Deletes an SSH Key you have access to.

**Note:** deleting an SSH Key will *not* remove it from any Linode or Disk that was deployed with `authorized_keys`. In those cases, the keys must be manually deleted on the Linode or Disk. This endpoint will only delete the key's association from your Profile.
| +| | `EXEC` | | Returns a single SSH Key object identified by `id` that you have access to view.
| +| | `EXEC` | | Returns a collection of SSH Keys you've added to your Profile.
| +| | `EXEC` | | Updates an SSH Key that you have permission to `read_write`.

Only SSH key labels can be updated.
| diff --git a/docs/linode-docs/providers/linode/profile/tfa_disable/index.md b/docs/linode-docs/providers/linode/profile/tfa_disable/index.md index e49c28fb2a..4d8fc73825 100644 --- a/docs/linode-docs/providers/linode/profile/tfa_disable/index.md +++ b/docs/linode-docs/providers/linode/profile/tfa_disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametfa_disable
TypeResource
Idlinode.profile.tfa_disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `tfaDisable` | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/profile/tfa_enable/index.md b/docs/linode-docs/providers/linode/profile/tfa_enable/index.md index 117ca90599..f8a1974974 100644 --- a/docs/linode-docs/providers/linode/profile/tfa_enable/index.md +++ b/docs/linode-docs/providers/linode/profile/tfa_enable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametfa_enable
TypeResource
Idlinode.profile.tfa_enable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `tfaEnable` | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/profile/tfa_enable_confirm/index.md b/docs/linode-docs/providers/linode/profile/tfa_enable_confirm/index.md index d2746812ba..9763e374ad 100644 --- a/docs/linode-docs/providers/linode/profile/tfa_enable_confirm/index.md +++ b/docs/linode-docs/providers/linode/profile/tfa_enable_confirm/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametfa_enable_confirm
TypeResource
Idlinode.profile.tfa_enable_confirm
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `tfaConfirm` | `EXEC` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/profile/tokens/index.md b/docs/linode-docs/providers/linode/profile/tokens/index.md index 156eccf2be..30ae12ca03 100644 --- a/docs/linode-docs/providers/linode/profile/tokens/index.md +++ b/docs/linode-docs/providers/linode/profile/tokens/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametokens
TypeResource
Idlinode.profile.tokens
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | This token's unique ID, which can be used to revoke it.
| -| `label` | `string` | This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for.
| -| `scopes` | `string` | The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the <a target="_top" href="https://github.com/linode/linode-cli">Linode CLI</a>, require tokens with access to `*`. Tokens with more restrictive scopes are generally more secure.
| -| `token` | `string` | The token used to access the API. When the token is created, the full token is returned here. Otherwise, only the first 16 characters are returned.
| -| `created` | `string` | The date and time this token was created.
| -| `expiry` | `string` | When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with "null" as their expiry and will never expire unless revoked.
| +| | `integer` | This token's unique ID, which can be used to revoke it.
| +| | `string` | The date and time this token was created.
| +| | `string` | When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with "null" as their expiry and will never expire unless revoked.
| +| | `string` | This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for.
| +| | `string` | The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the <a target="_top" href="https://github.com/linode/linode-cli">Linode CLI</a>, require tokens with access to `*`. Tokens with more restrictive scopes are generally more secure.
| +| | `string` | The token used to access the API. When the token is created, the full token is returned here. Otherwise, only the first 16 characters are returned.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPersonalAccessToken` | `SELECT` | `tokenId` | Returns a single Personal Access Token.
| -| `getPersonalAccessTokens` | `SELECT` | | Returns a paginated list of Personal Access Tokens currently active for your User.
| -| `createPersonalAccessToken` | `INSERT` | | Creates a Personal Access Token for your User. The raw token will be returned in the response, but will never be returned again afterward so be sure to take note of it. You may create a token with _at most_ the scopes of your current token. The created token will be able to access your Account until the given expiry, or until it is revoked.
| -| `deletePersonalAccessToken` | `DELETE` | `tokenId` | Revokes a Personal Access Token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is possible to revoke access to the token making the request to revoke a token, but keep in mind that doing so could lose you access to the api and require you to create a new token through some other means.
| -| `_getPersonalAccessToken` | `EXEC` | `tokenId` | Returns a single Personal Access Token.
| -| `_getPersonalAccessTokens` | `EXEC` | | Returns a paginated list of Personal Access Tokens currently active for your User.
| -| `updatePersonalAccessToken` | `EXEC` | `tokenId` | Updates a Personal Access Token.
| +| | `SELECT` | | Returns a single Personal Access Token.
| +| | `SELECT` | | Returns a paginated list of Personal Access Tokens currently active for your User.
| +| | `INSERT` | | Creates a Personal Access Token for your User. The raw token will be returned in the response, but will never be returned again afterward so be sure to take note of it. You may create a token with _at most_ the scopes of your current token. The created token will be able to access your Account until the given expiry, or until it is revoked.
| +| | `DELETE` | | Revokes a Personal Access Token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is possible to revoke access to the token making the request to revoke a token, but keep in mind that doing so could lose you access to the api and require you to create a new token through some other means.
| +| | `EXEC` | | Returns a single Personal Access Token.
| +| | `EXEC` | | Returns a paginated list of Personal Access Tokens currently active for your User.
| +| | `EXEC` | | Updates a Personal Access Token.
| diff --git a/docs/linode-docs/providers/linode/regions/index.md b/docs/linode-docs/providers/linode/regions/index.md index 0b34f9e15e..efba6f7181 100644 --- a/docs/linode-docs/providers/linode/regions/index.md +++ b/docs/linode-docs/providers/linode/regions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Regions :::info Service Summary diff --git a/docs/linode-docs/providers/linode/regions/regions/index.md b/docs/linode-docs/providers/linode/regions/regions/index.md index 18c00bd9eb..53301f6644 100644 --- a/docs/linode-docs/providers/linode/regions/regions/index.md +++ b/docs/linode-docs/providers/linode/regions/regions/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameregions
TypeResource
Idlinode.regions.regions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of this Region. | -| `label` | `string` | Detailed location information for this Region, including city, state or region, and country. | -| `resolvers` | `object` | | -| `status` | `string` | This region's current operational status.
| -| `capabilities` | `array` | A list of capabilities of this region.
| -| `country` | `string` | The country where this Region resides. | +| | `string` | The unique ID of this Region. | +| | `array` | A list of capabilities of this region.
| +| | `string` | The country where this Region resides. | +| | `string` | Detailed location information for this Region, including city, state or region, and country. | +| | `object` | | +| | `string` | This region's current operational status.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getRegion` | `SELECT` | `regionId` | Returns a single Region.
| -| `getRegions` | `SELECT` | | Lists the Regions available for Linode services. Not all services are guaranteed to be
available in all Regions.
| -| `_getRegion` | `EXEC` | `regionId` | Returns a single Region.
| -| `_getRegions` | `EXEC` | | Lists the Regions available for Linode services. Not all services are guaranteed to be
available in all Regions.
| +| | `SELECT` | | Returns a single Region.
| +| | `SELECT` | | Lists the Regions available for Linode services. Not all services are guaranteed to be
available in all Regions.
| +| | `EXEC` | | Returns a single Region.
| +| | `EXEC` | | Lists the Regions available for Linode services. Not all services are guaranteed to be
available in all Regions.
| diff --git a/docs/linode-docs/providers/linode/support/index.md b/docs/linode-docs/providers/linode/support/index.md index e09901194b..29c2123435 100644 --- a/docs/linode-docs/providers/linode/support/index.md +++ b/docs/linode-docs/providers/linode/support/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Support :::info Service Summary diff --git a/docs/linode-docs/providers/linode/support/tickets/index.md b/docs/linode-docs/providers/linode/support/tickets/index.md index a6f683e298..357b1804aa 100644 --- a/docs/linode-docs/providers/linode/support/tickets/index.md +++ b/docs/linode-docs/providers/linode/support/tickets/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametickets
TypeResource
Idlinode.support.tickets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The ID of the Support Ticket.
| -| `description` | `string` | The full details of the issue or question.
| -| `updated_by` | `string` | The User who last updated this Ticket.
| -| `summary` | `string` | The summary or title for this Ticket.
| -| `gravatar_id` | `string` | The Gravatar ID of the User who opened this Ticket.
| -| `closable` | `boolean` | Whether the Support Ticket may be closed.
| -| `updated` | `string` | The date and time this Ticket was last updated.
| -| `opened` | `string` | The date and time this Ticket was created.
| -| `status` | `string` | The current status of this Ticket. | -| `attachments` | `array` | A list of filenames representing attached files associated with this Ticket.
| -| `closed` | `string` | The date and time this Ticket was closed.
| -| `entity` | `object` | The entity this Ticket was opened for.
| -| `opened_by` | `string` | The User who opened this Ticket.
| +| | `integer` | The ID of the Support Ticket.
| +| | `string` | The full details of the issue or question.
| +| | `array` | A list of filenames representing attached files associated with this Ticket.
| +| | `boolean` | Whether the Support Ticket may be closed.
| +| | `string` | The date and time this Ticket was closed.
| +| | `object` | The entity this Ticket was opened for.
| +| | `string` | The Gravatar ID of the User who opened this Ticket.
| +| | `string` | The date and time this Ticket was created.
| +| | `string` | The User who opened this Ticket.
| +| | `string` | The current status of this Ticket. | +| | `string` | The summary or title for this Ticket.
| +| | `string` | The date and time this Ticket was last updated.
| +| | `string` | The User who last updated this Ticket.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getTicket` | `SELECT` | `ticketId` | Returns a Support Ticket under your Account.
| -| `getTickets` | `SELECT` | | Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account.
This collection includes all Support Tickets generated on your Account, with open tickets returned first.
| -| `createTicket` | `INSERT` | `data__description, data__summary` | Open a Support Ticket.
Only one of the ID attributes (`linode_id`, `domain_id`, etc.) can be set on a single Support Ticket.
| -| `_getTicket` | `EXEC` | `ticketId` | Returns a Support Ticket under your Account.
| -| `_getTickets` | `EXEC` | | Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account.
This collection includes all Support Tickets generated on your Account, with open tickets returned first.
| -| `closeTicket` | `EXEC` | `ticketId` | Closes a Support Ticket you have access to modify.
| +| | `SELECT` | | Returns a Support Ticket under your Account.
| +| | `SELECT` | | Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account.
This collection includes all Support Tickets generated on your Account, with open tickets returned first.
| +| | `INSERT` | | Open a Support Ticket.
Only one of the ID attributes (`linode_id`, `domain_id`, etc.) can be set on a single Support Ticket.
| +| | `EXEC` | | Returns a Support Ticket under your Account.
| +| | `EXEC` | | Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account.
This collection includes all Support Tickets generated on your Account, with open tickets returned first.
| +| | `EXEC` | | Closes a Support Ticket you have access to modify.
| diff --git a/docs/linode-docs/providers/linode/support/tickets_attachments/index.md b/docs/linode-docs/providers/linode/support/tickets_attachments/index.md index a61a20e251..85a1acf790 100644 --- a/docs/linode-docs/providers/linode/support/tickets_attachments/index.md +++ b/docs/linode-docs/providers/linode/support/tickets_attachments/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametickets_attachments
TypeResource
Idlinode.support.tickets_attachments
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/linode/stackql-linode-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createTicketAttachment` | `INSERT` | `ticketId` | +| | `INSERT` | | diff --git a/docs/linode-docs/providers/linode/support/tickets_replies/index.md b/docs/linode-docs/providers/linode/support/tickets_replies/index.md index 58f6c5c84a..7e53f3f332 100644 --- a/docs/linode-docs/providers/linode/support/tickets_replies/index.md +++ b/docs/linode-docs/providers/linode/support/tickets_replies/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametickets_replies
TypeResource
Idlinode.support.tickets_replies
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this Support Ticket reply.
| -| `description` | `string` | The body of this Support Ticket reply.
| -| `created` | `string` | The date and time this Ticket reply was created.
| -| `created_by` | `string` | The User who submitted this reply.
| -| `from_linode` | `boolean` | If set to true, this reply came from a Linode employee.
| -| `gravatar_id` | `string` | The Gravatar ID of the User who created this reply.
| +| | `integer` | The unique ID of this Support Ticket reply.
| +| | `string` | The body of this Support Ticket reply.
| +| | `string` | The date and time this Ticket reply was created.
| +| | `string` | The User who submitted this reply.
| +| | `boolean` | If set to true, this reply came from a Linode employee.
| +| | `string` | The Gravatar ID of the User who created this reply.
| ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getTicketReplies` | `SELECT` | `ticketId` | Returns a collection of replies to a Support Ticket on your Account.
| -| `createTicketReply` | `INSERT` | `ticketId, data__description` | Adds a reply to an existing Support Ticket.
| -| `_getTicketReplies` | `EXEC` | `ticketId` | Returns a collection of replies to a Support Ticket on your Account.
| +| | `SELECT` | | Returns a collection of replies to a Support Ticket on your Account.
| +| | `INSERT` | | Adds a reply to an existing Support Ticket.
| +| | `EXEC` | | Returns a collection of replies to a Support Ticket on your Account.
| diff --git a/docs/linode-docs/providers/linode/tags/index.md b/docs/linode-docs/providers/linode/tags/index.md index 6df4b33386..a8afafd257 100644 --- a/docs/linode-docs/providers/linode/tags/index.md +++ b/docs/linode-docs/providers/linode/tags/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Tags :::info Service Summary diff --git a/docs/linode-docs/providers/linode/tags/tags/index.md b/docs/linode-docs/providers/linode/tags/tags/index.md index db2a8486df..949f4596c6 100644 --- a/docs/linode-docs/providers/linode/tags/tags/index.md +++ b/docs/linode-docs/providers/linode/tags/tags/index.md @@ -14,21 +14,24 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Idlinode.tags.tags
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getTags` | `SELECT` | | Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.

This endpoint returns a paginated list of Tags on your account.
| -| `createTag` | `INSERT` | `data__label` | Creates a new Tag and optionally tags requested objects with it immediately.

**Important**: You must be an unrestricted User in order to add or modify Tags.
| -| `deleteTag` | `DELETE` | `label` | Remove a Tag from all objects and delete it.

**Important**: You must be an unrestricted User in order to add or modify Tags.
| -| `_getTags` | `EXEC` | | Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.

This endpoint returns a paginated list of Tags on your account.
| +| | `SELECT` | | Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.

This endpoint returns a paginated list of Tags on your account.
| +| | `INSERT` | | Creates a new Tag and optionally tags requested objects with it immediately.

**Important**: You must be an unrestricted User in order to add or modify Tags.
| +| | `DELETE` | | Remove a Tag from all objects and delete it.

**Important**: You must be an unrestricted User in order to add or modify Tags.
| +| | `EXEC` | | Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.

This endpoint returns a paginated list of Tags on your account.
| diff --git a/docs/linode-docs/providers/linode/view/index.md b/docs/linode-docs/providers/linode/view/index.md index c237e2d023..399c93e175 100644 --- a/docs/linode-docs/providers/linode/view/index.md +++ b/docs/linode-docs/providers/linode/view/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + View :::info Service Summary diff --git a/docs/linode-docs/providers/linode/view/tags/index.md b/docs/linode-docs/providers/linode/view/tags/index.md index fd1e622bf1..c2eed7776b 100644 --- a/docs/linode-docs/providers/linode/view/tags/index.md +++ b/docs/linode-docs/providers/linode/view/tags/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Idlinode.view.tags
Id
## Fields | Name | Datatype | |:-----|:---------| -| `data` | `` | -| `type` | `string` | +| || +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTaggedObjects` | `SELECT` | `label` | -| `_getTaggedObjects` | `EXEC` | `label` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/linode-docs/providers/linode/volumes/index.md b/docs/linode-docs/providers/linode/volumes/index.md index fe9cf93dd8..df34a93d13 100644 --- a/docs/linode-docs/providers/linode/volumes/index.md +++ b/docs/linode-docs/providers/linode/volumes/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- + Volumes :::info Service Summary diff --git a/docs/linode-docs/providers/linode/volumes/volumes/index.md b/docs/linode-docs/providers/linode/volumes/volumes/index.md index bfe91c9375..2c166ccb5f 100644 --- a/docs/linode-docs/providers/linode/volumes/volumes/index.md +++ b/docs/linode-docs/providers/linode/volumes/volumes/index.md @@ -14,42 +14,45 @@ description: Query, deploy and manage Linode resources using SQL custom_edit_url: null image: /img/providers/linode/stackql-linode-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolumes
TypeResource
Idlinode.volumes.volumes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | The unique ID of this Volume. | -| `label` | `string` | The Volume's label is for display purposes only.
| -| `size` | `integer` | The Volume's size, in GiB.
| -| `status` | `string` | The current status of the volume. Can be one of:

* `creating` - the Volume is being created and is not yet available
for use.
* `active` - the Volume is online and available for use.
* `resizing` - the Volume is in the process of upgrading
its current capacity.
| -| `linode_id` | `integer` | If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
| -| `tags` | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| -| `hardware_type` | `string` | The storage type of this Volume. | -| `updated` | `string` | When this Volume was last updated. | -| `region` | `string` | The unique ID of this Region. | -| `created` | `string` | When this Volume was created. | -| `filesystem_path` | `string` | The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.
| -| `linode_label` | `string` | If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
| +| | `integer` | The unique ID of this Volume. | +| | `string` | When this Volume was created. | +| | `string` | The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.
| +| | `string` | The storage type of this Volume. | +| | `string` | The Volume's label is for display purposes only.
| +| | `integer` | If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
| +| | `string` | If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
| +| | `string` | The unique ID of this Region. | +| | `integer` | The Volume's size, in GiB.
| +| | `string` | The current status of the volume. Can be one of:

* `creating` - the Volume is being created and is not yet available
for use.
* `active` - the Volume is online and available for use.
* `resizing` - the Volume is in the process of upgrading
its current capacity.
| +| | `array` | An array of Tags applied to this object. Tags are for organizational purposes only.
| +| | `string` | When this Volume was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getVolume` | `SELECT` | `volumeId` | Get information about a single Volume.
| -| `getVolumes` | `SELECT` | | Returns a paginated list of Volumes you have permission to view.
| -| `createVolume` | `INSERT` | `data__label` | Creates a Volume on your Account. In order for this to complete successfully, your User must have the `add_volumes` grant. Creating a new Volume will start accruing additional charges on your account.
| -| `deleteVolume` | `DELETE` | `volumeId` | Deletes a Volume you have permission to `read_write`.

* **Deleting a Volume is a destructive action and cannot be undone.**

* Deleting stops billing for the Volume. You will be billed for time used within
the billing period the Volume was active.

* Volumes that are migrating cannot be deleted until the migration is finished.
| -| `_getVolume` | `EXEC` | `volumeId` | Get information about a single Volume.
| -| `_getVolumes` | `EXEC` | | Returns a paginated list of Volumes you have permission to view.
| -| `attachVolume` | `EXEC` | `volumeId, data__linode_id` | Attaches a Volume on your Account to an existing Linode on your Account. In order for this request to complete successfully, your User must have `read_only` or `read_write` permission to the Volume and `read_write` permission to the Linode. Additionally, the Volume and Linode must be located in the same Region.
| -| `cloneVolume` | `EXEC` | `volumeId, data__label` | Creates a Volume on your Account. In order for this request to complete successfully, your User must have the `add_volumes` grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account.
* Only Volumes with a `status` of "active" can be cloned.
| -| `detachVolume` | `EXEC` | `volumeId` | Detaches a Volume on your Account from a Linode on your Account. In order for this request to complete successfully, your User must have `read_write` access to the Volume and `read_write` access to the Linode.
| -| `resizeVolume` | `EXEC` | `volumeId, data__size` | Resize an existing Volume on your Account. In order for this request to complete successfully, your User must have the `read_write` permissions to the Volume.
* Volumes can only be resized up.
* Only Volumes with a `status` of "active" can be resized.
| -| `updateVolume` | `EXEC` | `volumeId` | Updates a Volume that you have permission to `read_write`.
| +| | `SELECT` | | Get information about a single Volume.
| +| | `SELECT` | | Returns a paginated list of Volumes you have permission to view.
| +| | `INSERT` | | Creates a Volume on your Account. In order for this to complete successfully, your User must have the `add_volumes` grant. Creating a new Volume will start accruing additional charges on your account.
| +| | `DELETE` | | Deletes a Volume you have permission to `read_write`.

* **Deleting a Volume is a destructive action and cannot be undone.**

* Deleting stops billing for the Volume. You will be billed for time used within
the billing period the Volume was active.

* Volumes that are migrating cannot be deleted until the migration is finished.
| +| | `EXEC` | | Get information about a single Volume.
| +| | `EXEC` | | Returns a paginated list of Volumes you have permission to view.
| +| | `EXEC` | | Attaches a Volume on your Account to an existing Linode on your Account. In order for this request to complete successfully, your User must have `read_only` or `read_write` permission to the Volume and `read_write` permission to the Linode. Additionally, the Volume and Linode must be located in the same Region.
| +| | `EXEC` | | Creates a Volume on your Account. In order for this request to complete successfully, your User must have the `add_volumes` grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account.
* Only Volumes with a `status` of "active" can be cloned.
| +| | `EXEC` | | Detaches a Volume on your Account from a Linode on your Account. In order for this request to complete successfully, your User must have `read_write` access to the Volume and `read_write` access to the Linode.
| +| | `EXEC` | | Resize an existing Volume on your Account. In order for this request to complete successfully, your User must have the `read_write` permissions to the Volume.
* Volumes can only be resized up.
* Only Volumes with a `status` of "active" can be resized.
| +| | `EXEC` | | Updates a Volume that you have permission to `read_write`.
| diff --git a/docs/netlify-docs/index.md b/docs/netlify-docs/index.md index 5d004dcc93..4701709282 100644 --- a/docs/netlify-docs/index.md +++ b/docs/netlify-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png id: netlify-doc slug: /providers/netlify - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Web development and content distribution platform. :::info Provider Summary (v23.04.00141) @@ -49,7 +51,7 @@ REGISTRY PULL netlify; The following system environment variables are used for authentication by default: -- `NETLIFY_AUTH_TOKEN` - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) +- - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -111,4 +113,4 @@ stackql.exe shell --auth=$Auth ticket
user
- \ No newline at end of file + diff --git a/docs/netlify-docs/providers/netlify/access_token/index.md b/docs/netlify-docs/providers/netlify/access_token/index.md index bd4dfb152f..3e068f7dd5 100644 --- a/docs/netlify-docs/providers/netlify/access_token/index.md +++ b/docs/netlify-docs/providers/netlify/access_token/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + Access Token api :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/access_token/oauth_tickets_exchange/index.md b/docs/netlify-docs/providers/netlify/access_token/oauth_tickets_exchange/index.md index f3d3959d63..9709d14655 100644 --- a/docs/netlify-docs/providers/netlify/access_token/oauth_tickets_exchange/index.md +++ b/docs/netlify-docs/providers/netlify/access_token/oauth_tickets_exchange/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoauth_tickets_exchange
TypeResource
Idnetlify.access_token.oauth_tickets_exchange
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `exchangeTicket` | `EXEC` | `ticket_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/account_membership/accounts/index.md b/docs/netlify-docs/providers/netlify/account_membership/accounts/index.md index 4879508e7c..609f23130c 100644 --- a/docs/netlify-docs/providers/netlify/account_membership/accounts/index.md +++ b/docs/netlify-docs/providers/netlify/account_membership/accounts/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccounts
TypeResource
Idnetlify.account_membership.accounts
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `billing_period` | `string` | -| `created_at` | `string` | -| `type_name` | `string` | -| `billing_name` | `string` | -| `type_id` | `string` | -| `billing_email` | `string` | -| `updated_at` | `string` | -| `owner_ids` | `array` | -| `roles_allowed` | `array` | -| `slug` | `string` | -| `capabilities` | `object` | -| `billing_details` | `string` | -| `type` | `string` | -| `payment_method_id` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAccount` | `SELECT` | `account_id` | -| `listAccountsForUser` | `SELECT` | | -| `createAccount` | `INSERT` | `data__name, data__type_id` | -| `cancelAccount` | `EXEC` | `account_id` | -| `updateAccount` | `EXEC` | `account_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/account_membership/index.md b/docs/netlify-docs/providers/netlify/account_membership/index.md index f5d78d65da..c2a23042fa 100644 --- a/docs/netlify-docs/providers/netlify/account_membership/index.md +++ b/docs/netlify-docs/providers/netlify/account_membership/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + accountMembership :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/account_type/accounts_types/index.md b/docs/netlify-docs/providers/netlify/account_type/accounts_types/index.md index 1267a96259..a3a9cdd22e 100644 --- a/docs/netlify-docs/providers/netlify/account_type/accounts_types/index.md +++ b/docs/netlify-docs/providers/netlify/account_type/accounts_types/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccounts_types
TypeResource
Idnetlify.account_type.accounts_types
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `yearly_seats_addon_dollar_price` | `integer` | -| `capabilities` | `object` | -| `monthly_dollar_price` | `integer` | -| `monthly_seats_addon_dollar_price` | `integer` | -| `yearly_dollar_price` | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `integer` | +| | `integer` | +| | `integer` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listAccountTypesForUser` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/account_type/index.md b/docs/netlify-docs/providers/netlify/account_type/index.md index 49cc35c928..b410d02b30 100644 --- a/docs/netlify-docs/providers/netlify/account_type/index.md +++ b/docs/netlify-docs/providers/netlify/account_type/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + accountType :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/asset/index.md b/docs/netlify-docs/providers/netlify/asset/index.md index 1e60c7519b..f5a7a9857e 100644 --- a/docs/netlify-docs/providers/netlify/asset/index.md +++ b/docs/netlify-docs/providers/netlify/asset/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + asset :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/asset/sites_assets/index.md b/docs/netlify-docs/providers/netlify/asset/sites_assets/index.md index e13c478af3..d04617d48b 100644 --- a/docs/netlify-docs/providers/netlify/asset/sites_assets/index.md +++ b/docs/netlify-docs/providers/netlify/asset/sites_assets/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_assets
TypeResource
Idnetlify.asset.sites_assets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `visibility` | `string` | -| `size` | `integer` | -| `url` | `string` | -| `updated_at` | `string` | -| `created_at` | `string` | -| `content_type` | `string` | -| `creator_id` | `string` | -| `key` | `string` | -| `site_id` | `string` | -| `state` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteAssetInfo` | `SELECT` | `asset_id, site_id` | -| `listSiteAssets` | `SELECT` | `site_id` | -| `createSiteAsset` | `INSERT` | `site_id` | -| `deleteSiteAsset` | `DELETE` | `asset_id, site_id` | -| `updateSiteAsset` | `EXEC` | `asset_id, site_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/asset_public_signature/index.md b/docs/netlify-docs/providers/netlify/asset_public_signature/index.md index 0895d1c8f0..4c639f8af1 100644 --- a/docs/netlify-docs/providers/netlify/asset_public_signature/index.md +++ b/docs/netlify-docs/providers/netlify/asset_public_signature/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + assetPublicSignature :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/asset_public_signature/sites_assets_public_signature/index.md b/docs/netlify-docs/providers/netlify/asset_public_signature/sites_assets_public_signature/index.md index a48516ddc3..1b1a9ca6a4 100644 --- a/docs/netlify-docs/providers/netlify/asset_public_signature/sites_assets_public_signature/index.md +++ b/docs/netlify-docs/providers/netlify/asset_public_signature/sites_assets_public_signature/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_assets_public_signature
TypeResource
Idnetlify.asset_public_signature.sites_assets_public_signature
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteAssetPublicSignature` | `SELECT` | `asset_id, site_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/audit_log/accounts_audit/index.md b/docs/netlify-docs/providers/netlify/audit_log/accounts_audit/index.md index 8c8255218c..980a121fce 100644 --- a/docs/netlify-docs/providers/netlify/audit_log/accounts_audit/index.md +++ b/docs/netlify-docs/providers/netlify/audit_log/accounts_audit/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccounts_audit
TypeResource
Idnetlify.audit_log.accounts_audit
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `payload` | `object` | -| `account_id` | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listAccountAuditEvents` | `SELECT` | `account_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/audit_log/index.md b/docs/netlify-docs/providers/netlify/audit_log/index.md index e3132fab57..f13bdac4c0 100644 --- a/docs/netlify-docs/providers/netlify/audit_log/index.md +++ b/docs/netlify-docs/providers/netlify/audit_log/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + auditLog :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/build/builds/index.md b/docs/netlify-docs/providers/netlify/build/builds/index.md index 76096351a4..bd061db9ff 100644 --- a/docs/netlify-docs/providers/netlify/build/builds/index.md +++ b/docs/netlify-docs/providers/netlify/build/builds/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuilds
TypeResource
Idnetlify.build.builds
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `deploy_id` | `string` | -| `done` | `boolean` | -| `error` | `string` | -| `sha` | `string` | -| `created_at` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteBuild` | `SELECT` | `build_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/build/builds_start/index.md b/docs/netlify-docs/providers/netlify/build/builds_start/index.md index 3955e1bd87..5a75a5a121 100644 --- a/docs/netlify-docs/providers/netlify/build/builds_start/index.md +++ b/docs/netlify-docs/providers/netlify/build/builds_start/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuilds_start
TypeResource
Idnetlify.build.builds_start
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `notifyBuildStart` | `EXEC` | `build_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/build/builds_status/index.md b/docs/netlify-docs/providers/netlify/build/builds_status/index.md index 7899b87517..68f6997fbd 100644 --- a/docs/netlify-docs/providers/netlify/build/builds_status/index.md +++ b/docs/netlify-docs/providers/netlify/build/builds_status/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuilds_status
TypeResource
Idnetlify.build.builds_status
Id
## Fields | Name | Datatype | |:-----|:---------| -| `active` | `integer` | -| `build_count` | `integer` | -| `enqueued` | `integer` | -| `minutes` | `object` | -| `pending_concurrency` | `integer` | +| | `integer` | +| | `integer` | +| | `integer` | +| | `object` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAccountBuildStatus` | `SELECT` | `account_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/build/index.md b/docs/netlify-docs/providers/netlify/build/index.md index 2e2028bedf..1003f7abac 100644 --- a/docs/netlify-docs/providers/netlify/build/index.md +++ b/docs/netlify-docs/providers/netlify/build/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + build :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/build/sites_builds/index.md b/docs/netlify-docs/providers/netlify/build/sites_builds/index.md index 5aad456592..f309b77dda 100644 --- a/docs/netlify-docs/providers/netlify/build/sites_builds/index.md +++ b/docs/netlify-docs/providers/netlify/build/sites_builds/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_builds
TypeResource
Idnetlify.build.sites_builds
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `created_at` | `string` | -| `deploy_id` | `string` | -| `done` | `boolean` | -| `error` | `string` | -| `sha` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listSiteBuilds` | `SELECT` | `site_id` | -| `createSiteBuild` | `INSERT` | `site_id` | +| | `SELECT` | | +| | `INSERT` | | diff --git a/docs/netlify-docs/providers/netlify/build_hook/index.md b/docs/netlify-docs/providers/netlify/build_hook/index.md index bd7a2fec14..61b6876ce1 100644 --- a/docs/netlify-docs/providers/netlify/build_hook/index.md +++ b/docs/netlify-docs/providers/netlify/build_hook/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + buildHook :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/build_hook/sites_build_hooks/index.md b/docs/netlify-docs/providers/netlify/build_hook/sites_build_hooks/index.md index 4f11e82e3e..57a6377897 100644 --- a/docs/netlify-docs/providers/netlify/build_hook/sites_build_hooks/index.md +++ b/docs/netlify-docs/providers/netlify/build_hook/sites_build_hooks/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_build_hooks
TypeResource
Idnetlify.build_hook.sites_build_hooks
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `branch` | `string` | -| `created_at` | `string` | -| `site_id` | `string` | -| `title` | `string` | -| `url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteBuildHook` | `SELECT` | `id, site_id` | -| `listSiteBuildHooks` | `SELECT` | `site_id` | -| `createSiteBuildHook` | `INSERT` | `site_id` | -| `deleteSiteBuildHook` | `DELETE` | `id, site_id` | -| `updateSiteBuildHook` | `EXEC` | `id, site_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/build_log_msg/builds_log/index.md b/docs/netlify-docs/providers/netlify/build_log_msg/builds_log/index.md index f8854a5b25..a5ff15bf9f 100644 --- a/docs/netlify-docs/providers/netlify/build_log_msg/builds_log/index.md +++ b/docs/netlify-docs/providers/netlify/build_log_msg/builds_log/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuilds_log
TypeResource
Idnetlify.build_log_msg.builds_log
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `updateSiteBuildLog` | `EXEC` | `build_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/build_log_msg/index.md b/docs/netlify-docs/providers/netlify/build_log_msg/index.md index 022d1a837b..2731efc8fa 100644 --- a/docs/netlify-docs/providers/netlify/build_log_msg/index.md +++ b/docs/netlify-docs/providers/netlify/build_log_msg/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + buildLogMsg :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/deploy/deploys/index.md b/docs/netlify-docs/providers/netlify/deploy/deploys/index.md index 27f90df90c..6eeb4bc37e 100644 --- a/docs/netlify-docs/providers/netlify/deploy/deploys/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/deploys/index.md @@ -14,51 +14,54 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys
TypeResource
Idnetlify.deploy.deploys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `site_capabilities` | `object` | -| `ssl_url` | `string` | -| `site_id` | `string` | -| `review_url` | `string` | -| `title` | `string` | -| `skipped` | `boolean` | -| `state` | `string` | -| `branch` | `string` | -| `required` | `array` | -| `user_id` | `string` | -| `screenshot_url` | `string` | -| `required_functions` | `array` | -| `published_at` | `string` | -| `framework` | `string` | -| `updated_at` | `string` | -| `created_at` | `string` | -| `error_message` | `string` | -| `admin_url` | `string` | -| `commit_url` | `string` | -| `locked` | `boolean` | -| `url` | `string` | -| `review_id` | `number` | -| `deploy_url` | `string` | -| `deploy_ssl_url` | `string` | -| `function_schedules` | `array` | -| `build_id` | `string` | -| `draft` | `boolean` | -| `commit_ref` | `string` | -| `context` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `array` | +| | `boolean` | +| | `string` | +| | `array` | +| | `array` | +| | `number` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDeploy` | `SELECT` | `deploy_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/deploys_cancel/index.md b/docs/netlify-docs/providers/netlify/deploy/deploys_cancel/index.md index b039482d67..29fef51233 100644 --- a/docs/netlify-docs/providers/netlify/deploy/deploys_cancel/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/deploys_cancel/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys_cancel
TypeResource
Idnetlify.deploy.deploys_cancel
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `cancelSiteDeploy` | `EXEC` | `deploy_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/deploys_lock/index.md b/docs/netlify-docs/providers/netlify/deploy/deploys_lock/index.md index 84d27535f8..05736f9992 100644 --- a/docs/netlify-docs/providers/netlify/deploy/deploys_lock/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/deploys_lock/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys_lock
TypeResource
Idnetlify.deploy.deploys_lock
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `lockDeploy` | `EXEC` | `deploy_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/deploys_unlock/index.md b/docs/netlify-docs/providers/netlify/deploy/deploys_unlock/index.md index a55a510ec5..1c90eb207d 100644 --- a/docs/netlify-docs/providers/netlify/deploy/deploys_unlock/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/deploys_unlock/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys_unlock
TypeResource
Idnetlify.deploy.deploys_unlock
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `unlockDeploy` | `EXEC` | `deploy_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/index.md b/docs/netlify-docs/providers/netlify/deploy/index.md index d1a9268886..9a9282ce9d 100644 --- a/docs/netlify-docs/providers/netlify/deploy/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + deploy :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/deploy/sites_deploys/index.md b/docs/netlify-docs/providers/netlify/deploy/sites_deploys/index.md index d9a41922b5..7914064bac 100644 --- a/docs/netlify-docs/providers/netlify/deploy/sites_deploys/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/sites_deploys/index.md @@ -14,54 +14,57 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_deploys
TypeResource
Idnetlify.deploy.sites_deploys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `ssl_url` | `string` | -| `context` | `string` | -| `title` | `string` | -| `locked` | `boolean` | -| `updated_at` | `string` | -| `draft` | `boolean` | -| `admin_url` | `string` | -| `commit_ref` | `string` | -| `function_schedules` | `array` | -| `framework` | `string` | -| `required` | `array` | -| `error_message` | `string` | -| `published_at` | `string` | -| `site_id` | `string` | -| `branch` | `string` | -| `required_functions` | `array` | -| `commit_url` | `string` | -| `skipped` | `boolean` | -| `deploy_ssl_url` | `string` | -| `screenshot_url` | `string` | -| `site_capabilities` | `object` | -| `deploy_url` | `string` | -| `created_at` | `string` | -| `review_url` | `string` | -| `user_id` | `string` | -| `url` | `string` | -| `review_id` | `number` | -| `state` | `string` | -| `build_id` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `array` | +| | `boolean` | +| | `string` | +| | `array` | +| | `array` | +| | `number` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteDeploy` | `SELECT` | `deploy_id, site_id` | -| `listSiteDeploys` | `SELECT` | `site_id` | -| `createSiteDeploy` | `INSERT` | `site_id` | -| `updateSiteDeploy` | `EXEC` | `deploy_id, site_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/sites_deploys_restore/index.md b/docs/netlify-docs/providers/netlify/deploy/sites_deploys_restore/index.md index 6cbfe233ab..0919159ad9 100644 --- a/docs/netlify-docs/providers/netlify/deploy/sites_deploys_restore/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/sites_deploys_restore/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_deploys_restore
TypeResource
Idnetlify.deploy.sites_deploys_restore
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `restoreSiteDeploy` | `EXEC` | `deploy_id, site_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy/sites_rollback/index.md b/docs/netlify-docs/providers/netlify/deploy/sites_rollback/index.md index e25fc3caea..36a3c31006 100644 --- a/docs/netlify-docs/providers/netlify/deploy/sites_rollback/index.md +++ b/docs/netlify-docs/providers/netlify/deploy/sites_rollback/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_rollback
TypeResource
Idnetlify.deploy.sites_rollback
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `rollbackSiteDeploy` | `EXEC` | `site_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/deploy_key/deploy_keys/index.md b/docs/netlify-docs/providers/netlify/deploy_key/deploy_keys/index.md index b1d67b7f17..c3d7615904 100644 --- a/docs/netlify-docs/providers/netlify/deploy_key/deploy_keys/index.md +++ b/docs/netlify-docs/providers/netlify/deploy_key/deploy_keys/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploy_keys
TypeResource
Idnetlify.deploy_key.deploy_keys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `public_key` | `string` | -| `created_at` | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDeployKey` | `SELECT` | `key_id` | -| `listDeployKeys` | `SELECT` | | -| `createDeployKey` | `INSERT` | | -| `deleteDeployKey` | `DELETE` | `key_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | diff --git a/docs/netlify-docs/providers/netlify/deploy_key/index.md b/docs/netlify-docs/providers/netlify/deploy_key/index.md index 3ae658cce9..7c60ff88e9 100644 --- a/docs/netlify-docs/providers/netlify/deploy_key/index.md +++ b/docs/netlify-docs/providers/netlify/deploy_key/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + deployKey :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/deployed_branch/index.md b/docs/netlify-docs/providers/netlify/deployed_branch/index.md index bf4098714b..b9906cb886 100644 --- a/docs/netlify-docs/providers/netlify/deployed_branch/index.md +++ b/docs/netlify-docs/providers/netlify/deployed_branch/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + deployedBranch :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/deployed_branch/sites_deployed_branches/index.md b/docs/netlify-docs/providers/netlify/deployed_branch/sites_deployed_branches/index.md index a2d5e8bff8..ef368d7ecb 100644 --- a/docs/netlify-docs/providers/netlify/deployed_branch/sites_deployed_branches/index.md +++ b/docs/netlify-docs/providers/netlify/deployed_branch/sites_deployed_branches/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_deployed_branches
TypeResource
Idnetlify.deployed_branch.sites_deployed_branches
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `url` | `string` | -| `deploy_id` | `string` | -| `slug` | `string` | -| `ssl_url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listSiteDeployedBranches` | `SELECT` | `site_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones/index.md b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones/index.md index d4a8d9f92e..73176efbd7 100644 --- a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones/index.md +++ b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedns_zones
TypeResource
Idnetlify.dns_zone.dns_zones
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `user_id` | `string` | -| `errors` | `array` | -| `account_slug` | `string` | -| `dns_servers` | `array` | -| `domain` | `string` | -| `account_id` | `string` | -| `supported_record_types` | `array` | -| `ipv6_enabled` | `boolean` | -| `records` | `array` | -| `site_id` | `string` | -| `updated_at` | `string` | -| `account_name` | `string` | -| `dedicated` | `boolean` | -| `created_at` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `array` | +| | `string` | +| | `array` | +| | `boolean` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDnsZone` | `SELECT` | `zone_id` | -| `getDnsZones` | `SELECT` | | -| `createDnsZone` | `INSERT` | | -| `deleteDnsZone` | `DELETE` | `zone_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | diff --git a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_dns_records/index.md b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_dns_records/index.md index 52cfcd7384..d7d3e268df 100644 --- a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_dns_records/index.md +++ b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_dns_records/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedns_zones_dns_records
TypeResource
Idnetlify.dns_zone.dns_zones_dns_records
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `flag` | `integer` | -| `managed` | `boolean` | -| `tag` | `string` | -| `value` | `string` | -| `dns_zone_id` | `string` | -| `priority` | `integer` | -| `type` | `string` | -| `hostname` | `string` | -| `site_id` | `string` | -| `ttl` | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDnsRecords` | `SELECT` | `zone_id` | -| `getIndividualDnsRecord` | `SELECT` | `dns_record_id, zone_id` | -| `createDnsRecord` | `INSERT` | `zone_id` | -| `deleteDnsRecord` | `DELETE` | `dns_record_id, zone_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | diff --git a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_transfer/index.md b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_transfer/index.md index fae3edfdce..4c12d2e6eb 100644 --- a/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_transfer/index.md +++ b/docs/netlify-docs/providers/netlify/dns_zone/dns_zones_transfer/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedns_zones_transfer
TypeResource
Idnetlify.dns_zone.dns_zones_transfer
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `transferDnsZone` | `EXEC` | `account_id, transfer_account_id, transfer_user_id, zone_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/dns_zone/index.md b/docs/netlify-docs/providers/netlify/dns_zone/index.md index 3cad1d0469..c009bbc037 100644 --- a/docs/netlify-docs/providers/netlify/dns_zone/index.md +++ b/docs/netlify-docs/providers/netlify/dns_zone/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + dnsZone :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/dns_zone/sites_dns/index.md b/docs/netlify-docs/providers/netlify/dns_zone/sites_dns/index.md index ae2ef16495..efd424e14c 100644 --- a/docs/netlify-docs/providers/netlify/dns_zone/sites_dns/index.md +++ b/docs/netlify-docs/providers/netlify/dns_zone/sites_dns/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_dns
TypeResource
Idnetlify.dns_zone.sites_dns
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `dedicated` | `boolean` | -| `user_id` | `string` | -| `errors` | `array` | -| `updated_at` | `string` | -| `site_id` | `string` | -| `domain` | `string` | -| `dns_servers` | `array` | -| `ipv6_enabled` | `boolean` | -| `records` | `array` | -| `account_slug` | `string` | -| `account_id` | `string` | -| `supported_record_types` | `array` | -| `account_name` | `string` | -| `created_at` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `array` | +| | `string` | +| | `array` | +| | `boolean` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getDNSForSite` | `SELECT` | `site_id` | -| `configureDNSForSite` | `EXEC` | `site_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/file/deploys_files/index.md b/docs/netlify-docs/providers/netlify/file/deploys_files/index.md index 352f1ca864..dc1e76f9a3 100644 --- a/docs/netlify-docs/providers/netlify/file/deploys_files/index.md +++ b/docs/netlify-docs/providers/netlify/file/deploys_files/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys_files
TypeResource
Idnetlify.file.deploys_files
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `uploadDeployFile` | `EXEC` | `deploy_id, path` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/file/index.md b/docs/netlify-docs/providers/netlify/file/index.md index 07566c062b..9299ab5b7a 100644 --- a/docs/netlify-docs/providers/netlify/file/index.md +++ b/docs/netlify-docs/providers/netlify/file/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + file :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/file/sites_files/index.md b/docs/netlify-docs/providers/netlify/file/sites_files/index.md index 8ed28e2689..5de62931a2 100644 --- a/docs/netlify-docs/providers/netlify/file/sites_files/index.md +++ b/docs/netlify-docs/providers/netlify/file/sites_files/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_files
TypeResource
Idnetlify.file.sites_files
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `mime_type` | `string` | -| `path` | `string` | -| `sha` | `string` | -| `size` | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteFileByPathName` | `SELECT` | `file_path, site_id` | -| `listSiteFiles` | `SELECT` | `site_id` | +| | `SELECT` | | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/form/index.md b/docs/netlify-docs/providers/netlify/form/index.md index bb97792ab1..2333179902 100644 --- a/docs/netlify-docs/providers/netlify/form/index.md +++ b/docs/netlify-docs/providers/netlify/form/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + form :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/form/sites_forms/index.md b/docs/netlify-docs/providers/netlify/form/sites_forms/index.md index e009017e09..532cc3c1fe 100644 --- a/docs/netlify-docs/providers/netlify/form/sites_forms/index.md +++ b/docs/netlify-docs/providers/netlify/form/sites_forms/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_forms
TypeResource
Idnetlify.form.sites_forms
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `submission_count` | `integer` | -| `created_at` | `string` | -| `fields` | `array` | -| `paths` | `array` | -| `site_id` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `array` | +| | `string` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listSiteForms` | `SELECT` | `site_id` | -| `deleteSiteForm` | `DELETE` | `form_id, site_id` | +| | `SELECT` | | +| | `DELETE` | | diff --git a/docs/netlify-docs/providers/netlify/function/deploys_functions/index.md b/docs/netlify-docs/providers/netlify/function/deploys_functions/index.md index b5b9026cec..f67c24ac90 100644 --- a/docs/netlify-docs/providers/netlify/function/deploys_functions/index.md +++ b/docs/netlify-docs/providers/netlify/function/deploys_functions/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeploys_functions
TypeResource
Idnetlify.function.deploys_functions
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `uploadDeployFunction` | `EXEC` | `deploy_id, name` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/function/index.md b/docs/netlify-docs/providers/netlify/function/index.md index 36873fb879..5058fabcb4 100644 --- a/docs/netlify-docs/providers/netlify/function/index.md +++ b/docs/netlify-docs/providers/netlify/function/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + function :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/hook/hooks/index.md b/docs/netlify-docs/providers/netlify/hook/hooks/index.md index 81e0d2c104..a31a3bd0fb 100644 --- a/docs/netlify-docs/providers/netlify/hook/hooks/index.md +++ b/docs/netlify-docs/providers/netlify/hook/hooks/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehooks
TypeResource
Idnetlify.hook.hooks
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `site_id` | `string` | -| `type` | `string` | -| `updated_at` | `string` | -| `created_at` | `string` | -| `data` | `object` | -| `disabled` | `boolean` | -| `event` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getHook` | `SELECT` | `hook_id` | -| `listHooksBySiteId` | `SELECT` | `site_id` | -| `createHookBySiteId` | `INSERT` | `site_id` | -| `deleteHook` | `DELETE` | `hook_id` | -| `updateHook` | `EXEC` | `hook_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/hook/hooks_enable/index.md b/docs/netlify-docs/providers/netlify/hook/hooks_enable/index.md index b4dfbf46b1..1dd0edd541 100644 --- a/docs/netlify-docs/providers/netlify/hook/hooks_enable/index.md +++ b/docs/netlify-docs/providers/netlify/hook/hooks_enable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehooks_enable
TypeResource
Idnetlify.hook.hooks_enable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enableHook` | `EXEC` | `hook_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/hook/index.md b/docs/netlify-docs/providers/netlify/hook/index.md index 857b088677..8de7b64a43 100644 --- a/docs/netlify-docs/providers/netlify/hook/index.md +++ b/docs/netlify-docs/providers/netlify/hook/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + hook :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/hook_type/hooks_types/index.md b/docs/netlify-docs/providers/netlify/hook_type/hooks_types/index.md index aadd7b4ad9..efef613fec 100644 --- a/docs/netlify-docs/providers/netlify/hook_type/hooks_types/index.md +++ b/docs/netlify-docs/providers/netlify/hook_type/hooks_types/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehooks_types
TypeResource
Idnetlify.hook_type.hooks_types
Id
## Fields | Name | Datatype | |:-----|:---------| -| `name` | `string` | -| `fields` | `array` | -| `events` | `array` | +| | `string` | +| | `array` | +| | `array` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listHookTypes` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/hook_type/index.md b/docs/netlify-docs/providers/netlify/hook_type/index.md index dacb9b3f0b..0946274308 100644 --- a/docs/netlify-docs/providers/netlify/hook_type/index.md +++ b/docs/netlify-docs/providers/netlify/hook_type/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + hookType :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/member/index.md b/docs/netlify-docs/providers/netlify/member/index.md index 78975312b6..4eb0e8225d 100644 --- a/docs/netlify-docs/providers/netlify/member/index.md +++ b/docs/netlify-docs/providers/netlify/member/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + member :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/member/members/index.md b/docs/netlify-docs/providers/netlify/member/members/index.md index da3719e474..bac017ec4c 100644 --- a/docs/netlify-docs/providers/netlify/member/members/index.md +++ b/docs/netlify-docs/providers/netlify/member/members/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemembers
TypeResource
Idnetlify.member.members
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `full_name` | `string` | -| `role` | `string` | -| `avatar` | `string` | -| `email` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listMembersForAccount` | `SELECT` | `account_slug` | -| `addMemberToAccount` | `INSERT` | `account_slug` | +| | `SELECT` | | +| | `INSERT` | | diff --git a/docs/netlify-docs/providers/netlify/metadata/index.md b/docs/netlify-docs/providers/netlify/metadata/index.md index 1152f5d6d7..99d63f3639 100644 --- a/docs/netlify-docs/providers/netlify/metadata/index.md +++ b/docs/netlify-docs/providers/netlify/metadata/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + metadata :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/metadata/sites/index.md b/docs/netlify-docs/providers/netlify/metadata/sites/index.md index 5f1efdd378..f77aaad8b2 100644 --- a/docs/netlify-docs/providers/netlify/metadata/sites/index.md +++ b/docs/netlify-docs/providers/netlify/metadata/sites/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites
TypeResource
Idnetlify.metadata.sites
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteMetadata` | `EXEC` | `site_id` | -| `updateSiteMetadata` | `EXEC` | `site_id` | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/payment_method/billing_payment_methods/index.md b/docs/netlify-docs/providers/netlify/payment_method/billing_payment_methods/index.md index 8a888b0782..3570c25586 100644 --- a/docs/netlify-docs/providers/netlify/payment_method/billing_payment_methods/index.md +++ b/docs/netlify-docs/providers/netlify/payment_method/billing_payment_methods/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebilling_payment_methods
TypeResource
Idnetlify.payment_method.billing_payment_methods
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `method_name` | `string` | -| `state` | `string` | -| `type` | `string` | -| `updated_at` | `string` | -| `created_at` | `string` | -| `data` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listPaymentMethodsForUser` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/payment_method/index.md b/docs/netlify-docs/providers/netlify/payment_method/index.md index a2852b9b2e..0b8680b39b 100644 --- a/docs/netlify-docs/providers/netlify/payment_method/index.md +++ b/docs/netlify-docs/providers/netlify/payment_method/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + paymentMethod :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/service/index.md b/docs/netlify-docs/providers/netlify/service/index.md index f1d5297ad7..4992a9d02d 100644 --- a/docs/netlify-docs/providers/netlify/service/index.md +++ b/docs/netlify-docs/providers/netlify/service/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + service :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/service/services/index.md b/docs/netlify-docs/providers/netlify/service/services/index.md index d501def2ec..9cc1ad85da 100644 --- a/docs/netlify-docs/providers/netlify/service/services/index.md +++ b/docs/netlify-docs/providers/netlify/service/services/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices
TypeResource
Idnetlify.service.services
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `created_at` | `string` | -| `long_description` | `string` | -| `slug` | `string` | -| `environments` | `array` | -| `tags` | `array` | -| `service_path` | `string` | -| `events` | `array` | -| `icon` | `string` | -| `updated_at` | `string` | -| `manifest_url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getServices` | `SELECT` | | -| `showService` | `EXEC` | `addonName` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/service/services_manifest/index.md b/docs/netlify-docs/providers/netlify/service/services_manifest/index.md index f6d42604fd..2b7277a442 100644 --- a/docs/netlify-docs/providers/netlify/service/services_manifest/index.md +++ b/docs/netlify-docs/providers/netlify/service/services_manifest/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices_manifest
TypeResource
Idnetlify.service.services_manifest
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `showServiceManifest` | `EXEC` | `addonName` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/service_instance/index.md b/docs/netlify-docs/providers/netlify/service_instance/index.md index 78dcf1136c..ab86a61d3f 100644 --- a/docs/netlify-docs/providers/netlify/service_instance/index.md +++ b/docs/netlify-docs/providers/netlify/service_instance/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + serviceInstance :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/service_instance/sites_service_instances/index.md b/docs/netlify-docs/providers/netlify/service_instance/sites_service_instances/index.md index 523fdffda2..559d2bd141 100644 --- a/docs/netlify-docs/providers/netlify/service_instance/sites_service_instances/index.md +++ b/docs/netlify-docs/providers/netlify/service_instance/sites_service_instances/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_service_instances
TypeResource
Idnetlify.service_instance.sites_service_instances
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `service_name` | `string` | -| `service_slug` | `string` | -| `config` | `object` | -| `url` | `string` | -| `service_path` | `string` | -| `updated_at` | `string` | -| `snippets` | `array` | -| `env` | `object` | -| `auth_url` | `string` | -| `created_at` | `string` | -| `external_attributes` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listServiceInstancesForSite` | `SELECT` | `site_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/service_instance/sites_services_instances/index.md b/docs/netlify-docs/providers/netlify/service_instance/sites_services_instances/index.md index 4c5b9ab5bf..f78f726a6b 100644 --- a/docs/netlify-docs/providers/netlify/service_instance/sites_services_instances/index.md +++ b/docs/netlify-docs/providers/netlify/service_instance/sites_services_instances/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_services_instances
TypeResource
Idnetlify.service_instance.sites_services_instances
Id
## Fields @@ -29,7 +32,7 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createServiceInstance` | `INSERT` | `addon, site_id` | -| `deleteServiceInstance` | `DELETE` | `addon, instance_id, site_id` | -| `showServiceInstance` | `EXEC` | `addon, instance_id, site_id` | -| `updateServiceInstance` | `EXEC` | `addon, instance_id, site_id` | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/site/index.md b/docs/netlify-docs/providers/netlify/site/index.md index 9e3cf15dc5..a777b08d58 100644 --- a/docs/netlify-docs/providers/netlify/site/index.md +++ b/docs/netlify-docs/providers/netlify/site/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + site :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/site/sites/index.md b/docs/netlify-docs/providers/netlify/site/sites/index.md index 202edaa0f9..00b676e469 100644 --- a/docs/netlify-docs/providers/netlify/site/sites/index.md +++ b/docs/netlify-docs/providers/netlify/site/sites/index.md @@ -14,58 +14,61 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites
TypeResource
Idnetlify.site.sites
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `ssl_url` | `string` | -| `capabilities` | `object` | -| `screenshot_url` | `string` | -| `build_image` | `string` | -| `user_id` | `string` | -| `created_at` | `string` | -| `session_id` | `string` | -| `custom_domain` | `string` | -| `account_slug` | `string` | -| `deploy_hook` | `string` | -| `build_settings` | `object` | -| `notification_email` | `string` | -| `state` | `string` | -| `id_domain` | `string` | -| `domain_aliases` | `array` | -| `force_ssl` | `boolean` | -| `prerender` | `string` | -| `git_provider` | `string` | -| `password` | `string` | -| `url` | `string` | -| `plan` | `string` | -| `published_deploy` | `object` | -| `default_hooks_data` | `object` | -| `deploy_url` | `string` | -| `managed_dns` | `boolean` | -| `ssl` | `boolean` | -| `admin_url` | `string` | -| `updated_at` | `string` | -| `processing_settings` | `object` | -| `account_name` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSite` | `SELECT` | `site_id` | -| `listSites` | `SELECT` | | -| `listSitesForAccount` | `SELECT` | `account_slug` | -| `createSite` | `INSERT` | | -| `createSiteInTeam` | `INSERT` | `account_slug` | -| `deleteSite` | `DELETE` | `site_id` | -| `updateSite` | `EXEC` | `site_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/site/sites_unlink_repo/index.md b/docs/netlify-docs/providers/netlify/site/sites_unlink_repo/index.md index ad408a2051..68481fe959 100644 --- a/docs/netlify-docs/providers/netlify/site/sites_unlink_repo/index.md +++ b/docs/netlify-docs/providers/netlify/site/sites_unlink_repo/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_unlink_repo
TypeResource
Idnetlify.site.sites_unlink_repo
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `unlinkSiteRepo` | `EXEC` | `site_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/sni_certificate/index.md b/docs/netlify-docs/providers/netlify/sni_certificate/index.md index af0e6ea7cf..423a3d018f 100644 --- a/docs/netlify-docs/providers/netlify/sni_certificate/index.md +++ b/docs/netlify-docs/providers/netlify/sni_certificate/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + sniCertificate :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/sni_certificate/sites_ssl/index.md b/docs/netlify-docs/providers/netlify/sni_certificate/sites_ssl/index.md index 8ae2f25d44..908bda9c6c 100644 --- a/docs/netlify-docs/providers/netlify/sni_certificate/sites_ssl/index.md +++ b/docs/netlify-docs/providers/netlify/sni_certificate/sites_ssl/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_ssl
TypeResource
Idnetlify.sni_certificate.sites_ssl
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `provisionSiteTLSCertificate` | `EXEC` | `site_id` | -| `showSiteTLSCertificate` | `EXEC` | `site_id` | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/snippet/index.md b/docs/netlify-docs/providers/netlify/snippet/index.md index d686fcc23d..ac4411a320 100644 --- a/docs/netlify-docs/providers/netlify/snippet/index.md +++ b/docs/netlify-docs/providers/netlify/snippet/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + snippet :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/snippet/sites_snippets/index.md b/docs/netlify-docs/providers/netlify/snippet/sites_snippets/index.md index 5f00d88ea7..9c68049c5d 100644 --- a/docs/netlify-docs/providers/netlify/snippet/sites_snippets/index.md +++ b/docs/netlify-docs/providers/netlify/snippet/sites_snippets/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_snippets
TypeResource
Idnetlify.snippet.sites_snippets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `integer` | -| `goal` | `string` | -| `goal_position` | `string` | -| `site_id` | `string` | -| `title` | `string` | -| `general` | `string` | -| `general_position` | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSiteSnippet` | `SELECT` | `site_id, snippet_id` | -| `listSiteSnippets` | `SELECT` | `site_id` | -| `createSiteSnippet` | `INSERT` | `site_id` | -| `deleteSiteSnippet` | `DELETE` | `site_id, snippet_id` | -| `updateSiteSnippet` | `EXEC` | `site_id, snippet_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/split_test/index.md b/docs/netlify-docs/providers/netlify/split_test/index.md index f1364dfaea..c1c3f709d7 100644 --- a/docs/netlify-docs/providers/netlify/split_test/index.md +++ b/docs/netlify-docs/providers/netlify/split_test/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + splitTest :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits/index.md b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits/index.md index 89aa6334d9..15a4a42ab4 100644 --- a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits/index.md +++ b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_traffic_splits
TypeResource
Idnetlify.split_test.sites_traffic_splits
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `site_id` | `string` | -| `path` | `string` | -| `unpublished_at` | `string` | -| `branches` | `array` | -| `active` | `boolean` | -| `created_at` | `string` | -| `updated_at` | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSplitTest` | `SELECT` | `site_id, split_test_id` | -| `getSplitTests` | `SELECT` | `site_id` | -| `createSplitTest` | `INSERT` | `site_id` | -| `updateSplitTest` | `EXEC` | `site_id, split_test_id` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_publish/index.md b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_publish/index.md index 9260a230bf..36cbb55c03 100644 --- a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_publish/index.md +++ b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_publish/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_traffic_splits_publish
TypeResource
Idnetlify.split_test.sites_traffic_splits_publish
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enableSplitTest` | `EXEC` | `site_id, split_test_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_unpublish/index.md b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_unpublish/index.md index 8ccf508354..16622afb6d 100644 --- a/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_unpublish/index.md +++ b/docs/netlify-docs/providers/netlify/split_test/sites_traffic_splits_unpublish/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_traffic_splits_unpublish
TypeResource
Idnetlify.split_test.sites_traffic_splits_unpublish
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableSplitTest` | `EXEC` | `site_id, split_test_id` | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/submission/forms_submissions/index.md b/docs/netlify-docs/providers/netlify/submission/forms_submissions/index.md index 18248c22be..76f4c3c36f 100644 --- a/docs/netlify-docs/providers/netlify/submission/forms_submissions/index.md +++ b/docs/netlify-docs/providers/netlify/submission/forms_submissions/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameforms_submissions
TypeResource
Idnetlify.submission.forms_submissions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `body` | `string` | -| `company` | `string` | -| `email` | `string` | -| `summary` | `string` | -| `created_at` | `string` | -| `last_name` | `string` | -| `first_name` | `string` | -| `number` | `integer` | -| `data` | `object` | -| `site_url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listFormSubmissions` | `SELECT` | `form_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/submission/index.md b/docs/netlify-docs/providers/netlify/submission/index.md index 59e0afdee5..9d8fdafa42 100644 --- a/docs/netlify-docs/providers/netlify/submission/index.md +++ b/docs/netlify-docs/providers/netlify/submission/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + submission :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/submission/sites_submissions/index.md b/docs/netlify-docs/providers/netlify/submission/sites_submissions/index.md index 17b7923e24..3ca1fbcc6b 100644 --- a/docs/netlify-docs/providers/netlify/submission/sites_submissions/index.md +++ b/docs/netlify-docs/providers/netlify/submission/sites_submissions/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesites_submissions
TypeResource
Idnetlify.submission.sites_submissions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `number` | `integer` | -| `body` | `string` | -| `data` | `object` | -| `last_name` | `string` | -| `email` | `string` | -| `first_name` | `string` | -| `summary` | `string` | -| `created_at` | `string` | -| `site_url` | `string` | -| `company` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listSiteSubmissions` | `SELECT` | `site_id` | +| | `SELECT` | | diff --git a/docs/netlify-docs/providers/netlify/submission/submissions/index.md b/docs/netlify-docs/providers/netlify/submission/submissions/index.md index e7ebdcb959..df1c13455d 100644 --- a/docs/netlify-docs/providers/netlify/submission/submissions/index.md +++ b/docs/netlify-docs/providers/netlify/submission/submissions/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubmissions
TypeResource
Idnetlify.submission.submissions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `last_name` | `string` | -| `body` | `string` | -| `company` | `string` | -| `email` | `string` | -| `data` | `object` | -| `first_name` | `string` | -| `created_at` | `string` | -| `summary` | `string` | -| `number` | `integer` | -| `site_url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listFormSubmission` | `SELECT` | `submission_id` | -| `deleteSubmission` | `DELETE` | `submission_id` | +| | `SELECT` | | +| | `DELETE` | | diff --git a/docs/netlify-docs/providers/netlify/ticket/index.md b/docs/netlify-docs/providers/netlify/ticket/index.md index 026e3b6d4c..139aac8ef4 100644 --- a/docs/netlify-docs/providers/netlify/ticket/index.md +++ b/docs/netlify-docs/providers/netlify/ticket/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + ticket :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/ticket/oauth_tickets/index.md b/docs/netlify-docs/providers/netlify/ticket/oauth_tickets/index.md index d0ab473cec..0a039848b0 100644 --- a/docs/netlify-docs/providers/netlify/ticket/oauth_tickets/index.md +++ b/docs/netlify-docs/providers/netlify/ticket/oauth_tickets/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoauth_tickets
TypeResource
Idnetlify.ticket.oauth_tickets
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/netlify/stackql-netlify-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `createTicket` | `INSERT` | `client_id` | -| `showTicket` | `EXEC` | `ticket_id` | +| | `INSERT` | | +| | `EXEC` | | diff --git a/docs/netlify-docs/providers/netlify/user/index.md b/docs/netlify-docs/providers/netlify/user/index.md index 644886991b..d8838d540a 100644 --- a/docs/netlify-docs/providers/netlify/user/index.md +++ b/docs/netlify-docs/providers/netlify/user/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- + user :::info Service Summary diff --git a/docs/netlify-docs/providers/netlify/user/user/index.md b/docs/netlify-docs/providers/netlify/user/user/index.md index e41ae0bd6a..77cd25e3d1 100644 --- a/docs/netlify-docs/providers/netlify/user/user/index.md +++ b/docs/netlify-docs/providers/netlify/user/user/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Netlify resources using SQL custom_edit_url: null image: /img/providers/netlify/stackql-netlify-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser
TypeResource
Idnetlify.user.user
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `affiliate_id` | `string` | -| `avatar_url` | `string` | -| `uid` | `string` | -| `created_at` | `string` | -| `onboarding_progress` | `object` | -| `email` | `string` | -| `site_count` | `integer` | -| `login_providers` | `array` | -| `full_name` | `string` | -| `last_login` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `object` | +| | `integer` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getCurrentUser` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/okta-docs/index.md b/docs/okta-docs/index.md index 082e9c2065..f154a62159 100644 --- a/docs/okta-docs/index.md +++ b/docs/okta-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png id: okta-doc slug: /providers/okta - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Authentication and authorization services. :::info Provider Summary (v23.03.00121) @@ -49,7 +51,7 @@ REGISTRY PULL okta; The following system environment variables are used for authentication by default: -- `OKTA_API_TOKEN` - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) +- - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -115,4 +117,4 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement userschema
usertype
- \ No newline at end of file + diff --git a/docs/okta-docs/providers/okta/application/apps/index.md b/docs/okta-docs/providers/okta/application/apps/index.md index 6a956c6794..294f138100 100644 --- a/docs/okta-docs/providers/okta/application/apps/index.md +++ b/docs/okta-docs/providers/okta/application/apps/index.md @@ -14,43 +14,46 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapps
TypeResource
Idokta.application.apps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `label` | `string` | -| `profile` | `object` | -| `created` | `string` | -| `licensing` | `object` | -| `status` | `string` | -| `accessibility` | `object` | -| `lastUpdated` | `string` | -| `features` | `array` | -| `_links` | `object` | -| `settings` | `object` | -| `credentials` | `object` | -| `signOnMode` | `string` | -| `visibility` | `object` | -| `_embedded` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, subdomain` | Fetches an application from your Okta organization by `id`. | -| `list` | `SELECT` | `subdomain` | Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query. | -| `insert` | `INSERT` | `subdomain` | Adds a new application to your Okta organization. | -| `delete` | `DELETE` | `appId, subdomain` | Removes an inactive application. | -| `activate` | `EXEC` | `appId, subdomain` | Activates an inactive application. | -| `deactivate` | `EXEC` | `appId, subdomain` | Deactivates an active application. | -| `deleteall` | `EXEC` | `appId, subdomain` | Revokes all tokens for the specified application | -| `update` | `EXEC` | `appId, subdomain` | Updates an application in your organization. | +| | `SELECT` | | Fetches an application from your Okta organization by `id`. | +| | `SELECT` | | Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query. | +| | `INSERT` | | Adds a new application to your Okta organization. | +| | `DELETE` | | Removes an inactive application. | +| | `EXEC` | | Activates an inactive application. | +| | `EXEC` | | Deactivates an active application. | +| | `EXEC` | | Revokes all tokens for the specified application | +| | `EXEC` | | Updates an application in your organization. | diff --git a/docs/okta-docs/providers/okta/application/csrs/index.md b/docs/okta-docs/providers/okta/application/csrs/index.md index 9c04530ba8..8c2fe5c61d 100644 --- a/docs/okta-docs/providers/okta/application/csrs/index.md +++ b/docs/okta-docs/providers/okta/application/csrs/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecsrs
TypeResource
Idokta.application.csrs
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `kty` | `string` | -| `created` | `string` | -| `csr` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, csrId, subdomain` | | -| `list` | `SELECT` | `appId, subdomain` | Enumerates Certificate Signing Requests for an application | -| `insert` | `INSERT` | `appId, subdomain` | Generates a new key pair and returns the Certificate Signing Request for it. | -| `delete` | `DELETE` | `appId, csrId, subdomain` | | +| | `SELECT` | | | +| | `SELECT` | | Enumerates Certificate Signing Requests for an application | +| | `INSERT` | | Generates a new key pair and returns the Certificate Signing Request for it. | +| | `DELETE` | | | diff --git a/docs/okta-docs/providers/okta/application/grants/index.md b/docs/okta-docs/providers/okta/application/grants/index.md index 9404dafc97..64ca8423ad 100644 --- a/docs/okta-docs/providers/okta/application/grants/index.md +++ b/docs/okta-docs/providers/okta/application/grants/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegrants
TypeResource
Idokta.application.grants
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `_embedded` | `object` | -| `clientId` | `string` | -| `createdBy` | `object` | -| `issuer` | `string` | -| `lastUpdated` | `string` | -| `source` | `string` | -| `status` | `string` | -| `userId` | `string` | -| `_links` | `object` | -| `scopeId` | `string` | -| `created` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, grantId, subdomain` | Fetches a single scope consent grant for the application | -| `list` | `SELECT` | `appId, subdomain` | Lists all scope consent grants for the application | -| `insert` | `INSERT` | `appId, subdomain` | Grants consent for the application to request an OAuth 2.0 Okta scope | -| `delete` | `DELETE` | `appId, grantId, subdomain` | Revokes permission for the application to request the given scope | +| | `SELECT` | | Fetches a single scope consent grant for the application | +| | `SELECT` | | Lists all scope consent grants for the application | +| | `INSERT` | | Grants consent for the application to request an OAuth 2.0 Okta scope | +| | `DELETE` | | Revokes permission for the application to request the given scope | diff --git a/docs/okta-docs/providers/okta/application/groups/index.md b/docs/okta-docs/providers/okta/application/groups/index.md index ae52287cd6..d18e50cd41 100644 --- a/docs/okta-docs/providers/okta/application/groups/index.md +++ b/docs/okta-docs/providers/okta/application/groups/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegroups
TypeResource
Idokta.application.groups
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `profile` | `object` | -| `_embedded` | `object` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `priority` | `integer` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `integer` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, groupId, subdomain` | Fetches an application group assignment | -| `list` | `SELECT` | `appId, subdomain` | Enumerates group assignments for an application. | -| `delete` | `DELETE` | `appId, groupId, subdomain` | Removes a group assignment from an application. | -| `update` | `EXEC` | `appId, groupId, subdomain` | Assigns a group to an application | +| | `SELECT` | | Fetches an application group assignment | +| | `SELECT` | | Enumerates group assignments for an application. | +| | `DELETE` | | Removes a group assignment from an application. | +| | `EXEC` | | Assigns a group to an application | diff --git a/docs/okta-docs/providers/okta/application/index.md b/docs/okta-docs/providers/okta/application/index.md index f71bbd83aa..5a0fd2cd01 100644 --- a/docs/okta-docs/providers/okta/application/index.md +++ b/docs/okta-docs/providers/okta/application/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta application management api. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/application/keys/index.md b/docs/okta-docs/providers/okta/application/keys/index.md index 66fa778664..7f8bd82b20 100644 --- a/docs/okta-docs/providers/okta/application/keys/index.md +++ b/docs/okta-docs/providers/okta/application/keys/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekeys
TypeResource
Idokta.application.keys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `expiresAt` | `string` | -| `x5t#S256` | `string` | -| `key_ops` | `array` | -| `lastUpdated` | `string` | -| `use` | `string` | -| `x5t` | `string` | -| `status` | `string` | -| `alg` | `string` | -| `false` | `string` | -| `e` | `string` | -| `x5c` | `array` | -| `kid` | `string` | -| `kty` | `string` | -| `_links` | `object` | -| `x5u` | `string` | -| `created` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, keyId, subdomain` | Gets a specific application key credential by kid | -| `list` | `SELECT` | `appId, subdomain` | Enumerates key credentials for an application | -| `insert` | `INSERT` | `appId, subdomain` | Generates a new X.509 certificate for an application key credential | -| `delete` | `DELETE` | `appId, csrId, subdomain` | | +| | `SELECT` | | Gets a specific application key credential by kid | +| | `SELECT` | | Enumerates key credentials for an application | +| | `INSERT` | | Generates a new X.509 certificate for an application key credential | +| | `DELETE` | | | diff --git a/docs/okta-docs/providers/okta/application/tokens/index.md b/docs/okta-docs/providers/okta/application/tokens/index.md index 90567e8eac..b3a1a57b4b 100644 --- a/docs/okta-docs/providers/okta/application/tokens/index.md +++ b/docs/okta-docs/providers/okta/application/tokens/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametokens
TypeResource
Idokta.application.tokens
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `issuer` | `string` | -| `_embedded` | `object` | -| `created` | `string` | -| `status` | `string` | -| `_links` | `object` | -| `clientId` | `string` | -| `lastUpdated` | `string` | -| `scopes` | `array` | -| `expiresAt` | `string` | -| `userId` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, tokenId, subdomain` | Gets a token for the specified application | -| `list` | `SELECT` | `appId, subdomain` | Lists all tokens for the application | -| `delete` | `DELETE` | `appId, tokenId, subdomain` | Revokes the specified token for the specified application | +| | `SELECT` | | Gets a token for the specified application | +| | `SELECT` | | Lists all tokens for the application | +| | `DELETE` | | Revokes the specified token for the specified application | diff --git a/docs/okta-docs/providers/okta/application/users/index.md b/docs/okta-docs/providers/okta/application/users/index.md index 0834f8041f..002a300a1e 100644 --- a/docs/okta-docs/providers/okta/application/users/index.md +++ b/docs/okta-docs/providers/okta/application/users/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idokta.application.users
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `externalId` | `string` | -| `lastSync` | `string` | -| `statusChanged` | `string` | -| `credentials` | `object` | -| `scope` | `string` | -| `profile` | `object` | -| `created` | `string` | -| `syncState` | `string` | -| `lastUpdated` | `string` | -| `_links` | `object` | -| `passwordChanged` | `string` | -| `_embedded` | `object` | -| `status` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `appId, userId, subdomain` | Fetches a specific user assignment for application by `id`. | -| `list` | `SELECT` | `appId, subdomain` | Enumerates all assigned [application users](#application-user-model) for an application. | -| `insert` | `INSERT` | `appId, subdomain` | Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request. | -| `delete` | `DELETE` | `appId, userId, subdomain` | Removes an assignment for a user from an application. | -| `update` | `EXEC` | `appId, userId, subdomain` | Updates a user's profile for an application | +| | `SELECT` | | Fetches a specific user assignment for application by `id`. | +| | `SELECT` | | Enumerates all assigned [application users](#application-user-model) for an application. | +| | `INSERT` | | Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request. | +| | `DELETE` | | Removes an assignment for a user from an application. | +| | `EXEC` | | Updates a user's profile for an application | diff --git a/docs/okta-docs/providers/okta/authenticator/authenticators/index.md b/docs/okta-docs/providers/okta/authenticator/authenticators/index.md index d754a7322b..7cb9a54b58 100644 --- a/docs/okta-docs/providers/okta/authenticator/authenticators/index.md +++ b/docs/okta-docs/providers/okta/authenticator/authenticators/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameauthenticators
TypeResource
Idokta.authenticator.authenticators
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `settings` | `object` | -| `lastUpdated` | `string` | -| `created` | `string` | -| `type` | `string` | -| `_links` | `object` | -| `status` | `string` | -| `key` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `authenticatorId, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `activate` | `EXEC` | `authenticatorId, subdomain` | -| `deactivate` | `EXEC` | `authenticatorId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/authenticator/index.md b/docs/okta-docs/providers/okta/authenticator/index.md index a3b7ae2d27..4ee48e67cf 100644 --- a/docs/okta-docs/providers/okta/authenticator/index.md +++ b/docs/okta-docs/providers/okta/authenticator/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta authenticator management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/authorizationserver/authorizationservers/index.md b/docs/okta-docs/providers/okta/authorizationserver/authorizationservers/index.md index 6b9ed21af7..162e861a41 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/authorizationservers/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/authorizationservers/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameauthorizationservers
TypeResource
Idokta.authorizationserver.authorizationservers
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `issuerMode` | `string` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `created` | `string` | -| `credentials` | `object` | -| `audiences` | `array` | -| `issuer` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `authServerId, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `insert` | `INSERT` | `subdomain` | -| `delete` | `DELETE` | `authServerId, subdomain` | -| `activate` | `EXEC` | `authServerId, subdomain` | -| `deactivate` | `EXEC` | `authServerId, subdomain` | -| `update` | `EXEC` | `authServerId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/authorizationserver/claims/index.md b/docs/okta-docs/providers/okta/authorizationserver/claims/index.md index 665cba78b1..993ed46997 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/claims/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/claims/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclaims
TypeResource
Idokta.authorizationserver.claims
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `conditions` | `object` | -| `_links` | `object` | -| `claimType` | `string` | -| `system` | `boolean` | -| `valueType` | `string` | -| `alwaysIncludeInToken` | `boolean` | -| `value` | `string` | -| `status` | `string` | -| `group_filter_type` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `authServerId, claimId, subdomain` | -| `list` | `SELECT` | `authServerId, subdomain` | -| `insert` | `INSERT` | `authServerId, subdomain` | -| `delete` | `DELETE` | `authServerId, claimId, subdomain` | -| `update` | `EXEC` | `authServerId, claimId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/authorizationserver/clients/index.md b/docs/okta-docs/providers/okta/authorizationserver/clients/index.md index b6a57c4604..e93e98b032 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/clients/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/clients/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclients
TypeResource
Idokta.authorizationserver.clients
Id
## Fields | Name | Datatype | |:-----|:---------| -| `client_name` | `string` | -| `client_uri` | `string` | -| `logo_uri` | `string` | -| `_links` | `object` | -| `client_id` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `authServerId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/authorizationserver/index.md b/docs/okta-docs/providers/okta/authorizationserver/index.md index df3e411dea..aa26e4d3f6 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta authorization server management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/authorizationserver/keys/index.md b/docs/okta-docs/providers/okta/authorizationserver/keys/index.md index dd9fa385f4..f27b992dee 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/keys/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/keys/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekeys
TypeResource
Idokta.authorizationserver.keys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `lastUpdated` | `string` | -| `kid` | `string` | -| `x5t` | `string` | -| `x5c` | `array` | -| `_links` | `object` | -| `created` | `string` | -| `expiresAt` | `string` | -| `e` | `string` | -| `x5u` | `string` | -| `alg` | `string` | -| `key_ops` | `array` | -| `x5t#S256` | `string` | -| `status` | `string` | -| `use` | `string` | -| `kty` | `string` | -| `false` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `authServerId, subdomain` | -| `rotate` | `EXEC` | `authServerId, subdomain` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/authorizationserver/policies/index.md b/docs/okta-docs/providers/okta/authorizationserver/policies/index.md index 3b8a5d269a..dacfda3820 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/policies/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/policies/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepolicies
TypeResource
Idokta.authorizationserver.policies
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `type` | `string` | -| `created` | `string` | -| `_links` | `object` | -| `priority` | `integer` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `conditions` | `object` | -| `system` | `boolean` | -| `_embedded` | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `authServerId, policyId, subdomain` | Success | -| `list` | `SELECT` | `authServerId, subdomain` | Success | -| `insert` | `INSERT` | `authServerId, subdomain` | Success | -| `delete` | `DELETE` | `authServerId, policyId, subdomain` | Success | -| `activate` | `EXEC` | `authServerId, policyId, subdomain` | Activate Authorization Server Policy | -| `deactivate` | `EXEC` | `authServerId, policyId, subdomain` | Deactivate Authorization Server Policy | -| `update` | `EXEC` | `authServerId, policyId, subdomain` | Success | +| | `SELECT` | | Success | +| | `SELECT` | | Success | +| | `INSERT` | | Success | +| | `DELETE` | | Success | +| | `EXEC` | | Activate Authorization Server Policy | +| | `EXEC` | | Deactivate Authorization Server Policy | +| | `EXEC` | | Success | diff --git a/docs/okta-docs/providers/okta/authorizationserver/rules/index.md b/docs/okta-docs/providers/okta/authorizationserver/rules/index.md index ec8d465159..f3275a6581 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/rules/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/rules/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idokta.authorizationserver.rules
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `type` | `string` | -| `system` | `boolean` | -| `priority` | `integer` | -| `lastUpdated` | `string` | -| `conditions` | `object` | -| `status` | `string` | -| `created` | `string` | -| `actions` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `authServerId, policyId, ruleId, subdomain` | Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy. | -| `list` | `SELECT` | `authServerId, policyId, subdomain` | Enumerates all policy rules for the specified Custom Authorization Server and Policy. | -| `insert` | `INSERT` | `authServerId, policyId, subdomain` | Creates a policy rule for the specified Custom Authorization Server and Policy. | -| `delete` | `DELETE` | `authServerId, policyId, ruleId, subdomain` | Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy. | -| `activate` | `EXEC` | `authServerId, policyId, ruleId, subdomain` | Activate Authorization Server Policy Rule | -| `deactivate` | `EXEC` | `authServerId, policyId, ruleId, subdomain` | Deactivate Authorization Server Policy Rule | -| `update` | `EXEC` | `authServerId, policyId, ruleId, subdomain` | Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy. | +| | `SELECT` | | Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy. | +| | `SELECT` | | Enumerates all policy rules for the specified Custom Authorization Server and Policy. | +| | `INSERT` | | Creates a policy rule for the specified Custom Authorization Server and Policy. | +| | `DELETE` | | Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy. | +| | `EXEC` | | Activate Authorization Server Policy Rule | +| | `EXEC` | | Deactivate Authorization Server Policy Rule | +| | `EXEC` | | Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy. | diff --git a/docs/okta-docs/providers/okta/authorizationserver/scopes/index.md b/docs/okta-docs/providers/okta/authorizationserver/scopes/index.md index 69d2d48e99..9a28e1cbb5 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/scopes/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/scopes/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescopes
TypeResource
Idokta.authorizationserver.scopes
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `system` | `boolean` | -| `consent` | `string` | -| `default` | `boolean` | -| `displayName` | `string` | -| `metadataPublish` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `authServerId, scopeId, subdomain` | -| `list` | `SELECT` | `authServerId, subdomain` | -| `insert` | `INSERT` | `authServerId, subdomain` | -| `delete` | `DELETE` | `authServerId, scopeId, subdomain` | -| `update` | `EXEC` | `authServerId, scopeId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/authorizationserver/tokens/index.md b/docs/okta-docs/providers/okta/authorizationserver/tokens/index.md index 6059b557dc..02ce077ce1 100644 --- a/docs/okta-docs/providers/okta/authorizationserver/tokens/index.md +++ b/docs/okta-docs/providers/okta/authorizationserver/tokens/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametokens
TypeResource
Idokta.authorizationserver.tokens
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `created` | `string` | -| `createdBy` | `object` | -| `lastUpdated` | `string` | -| `scopes` | `array` | -| `expiresAt` | `string` | -| `_links` | `object` | -| `issuer` | `string` | -| `userId` | `string` | -| `status` | `string` | -| `_embedded` | `object` | -| `clientId` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `authServerId, clientId, tokenId, subdomain` | -| `list` | `SELECT` | `authServerId, clientId, subdomain` | -| `delete` | `DELETE` | `authServerId, clientId, tokenId, subdomain` | -| `deleteall` | `EXEC` | `authServerId, clientId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `DELETE` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/domain/certificates/index.md b/docs/okta-docs/providers/okta/domain/certificates/index.md index 0176e717b2..6f9443d403 100644 --- a/docs/okta-docs/providers/okta/domain/certificates/index.md +++ b/docs/okta-docs/providers/okta/domain/certificates/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecertificates
TypeResource
Idokta.domain.certificates
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `insert` | `INSERT` | `domainId, subdomain` | +| | `INSERT` | | diff --git a/docs/okta-docs/providers/okta/domain/domains/index.md b/docs/okta-docs/providers/okta/domain/domains/index.md index e7d1e8a08a..6b0c174d15 100644 --- a/docs/okta-docs/providers/okta/domain/domains/index.md +++ b/docs/okta-docs/providers/okta/domain/domains/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Idokta.domain.domains
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `domainId, subdomain` | Fetches a Domain by `id`. | -| `list` | `SELECT` | `subdomain` | List all verified custom Domains for the org. | -| `insert` | `INSERT` | `subdomain` | Creates your domain. | -| `delete` | `DELETE` | `domainId, subdomain` | Deletes a Domain by `id`. | -| `verify` | `EXEC` | `domainId, subdomain` | Verifies the Domain by `id`. | +| | `SELECT` | | Fetches a Domain by `id`. | +| | `SELECT` | | List all verified custom Domains for the org. | +| | `INSERT` | | Creates your domain. | +| | `DELETE` | | Deletes a Domain by `id`. | +| | `EXEC` | | Verifies the Domain by `id`. | diff --git a/docs/okta-docs/providers/okta/domain/index.md b/docs/okta-docs/providers/okta/domain/index.md index 3a81881005..a7cec2a917 100644 --- a/docs/okta-docs/providers/okta/domain/index.md +++ b/docs/okta-docs/providers/okta/domain/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta domain management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/eventhook/eventhooks/index.md b/docs/okta-docs/providers/okta/eventhook/eventhooks/index.md index 9159af6cd3..ae5c134643 100644 --- a/docs/okta-docs/providers/okta/eventhook/eventhooks/index.md +++ b/docs/okta-docs/providers/okta/eventhook/eventhooks/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameeventhooks
TypeResource
Idokta.eventhook.eventhooks
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `createdBy` | `string` | -| `lastUpdated` | `string` | -| `events` | `object` | -| `_links` | `object` | -| `channel` | `object` | -| `status` | `string` | -| `created` | `string` | -| `verificationStatus` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `eventHookId, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `insert` | `INSERT` | `subdomain` | -| `delete` | `DELETE` | `eventHookId, subdomain` | -| `activate` | `EXEC` | `eventHookId, subdomain` | -| `deactivate` | `EXEC` | `eventHookId, subdomain` | -| `update` | `EXEC` | `eventHookId, subdomain` | -| `verify` | `EXEC` | `eventHookId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/eventhook/index.md b/docs/okta-docs/providers/okta/eventhook/index.md index c0192c1a28..28dcb178b8 100644 --- a/docs/okta-docs/providers/okta/eventhook/index.md +++ b/docs/okta-docs/providers/okta/eventhook/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta event hook management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/feature/features/index.md b/docs/okta-docs/providers/okta/feature/features/index.md index feaaddf875..d30abca71e 100644 --- a/docs/okta-docs/providers/okta/feature/features/index.md +++ b/docs/okta-docs/providers/okta/feature/features/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefeatures
TypeResource
Idokta.feature.features
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `stage` | `object` | -| `status` | `string` | -| `type` | `string` | -| `_links` | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `featureId, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `listFeatureDependencies` | `EXEC` | `featureId, subdomain` | -| `listFeatureDependents` | `EXEC` | `featureId, subdomain` | -| `updateFeatureLifecycle` | `EXEC` | `featureId, lifecycle, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/feature/index.md b/docs/okta-docs/providers/okta/feature/index.md index 072b03d455..bbf9476874 100644 --- a/docs/okta-docs/providers/okta/feature/index.md +++ b/docs/okta-docs/providers/okta/feature/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta feature management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/group/appinstancetargets/index.md b/docs/okta-docs/providers/okta/group/appinstancetargets/index.md index b62b115224..ec32c5fc6f 100644 --- a/docs/okta-docs/providers/okta/group/appinstancetargets/index.md +++ b/docs/okta-docs/providers/okta/group/appinstancetargets/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameappinstancetargets
TypeResource
Idokta.group.appinstancetargets
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `insert` | `INSERT` | `appName, applicationId, groupId, roleId, subdomain` | Add App Instance Target to App Administrator Role given to a Group | -| `delete` | `DELETE` | `appName, applicationId, groupId, roleId, subdomain` | Remove App Instance Target to App Administrator Role given to a Group | +| | `INSERT` | | Add App Instance Target to App Administrator Role given to a Group | +| | `DELETE` | | Remove App Instance Target to App Administrator Role given to a Group | diff --git a/docs/okta-docs/providers/okta/group/apps/index.md b/docs/okta-docs/providers/okta/group/apps/index.md index 9eac7b219b..eb89f74495 100644 --- a/docs/okta-docs/providers/okta/group/apps/index.md +++ b/docs/okta-docs/providers/okta/group/apps/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapps
TypeResource
Idokta.group.apps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `credentials` | `object` | -| `created` | `string` | -| `profile` | `object` | -| `_links` | `object` | -| `_embedded` | `object` | -| `settings` | `object` | -| `label` | `string` | -| `lastUpdated` | `string` | -| `accessibility` | `object` | -| `licensing` | `object` | -| `status` | `string` | -| `features` | `array` | -| `signOnMode` | `string` | -| `visibility` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `groupId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/group/apptargets/index.md b/docs/okta-docs/providers/okta/group/apptargets/index.md index 5d080de7b2..bc996d1c20 100644 --- a/docs/okta-docs/providers/okta/group/apptargets/index.md +++ b/docs/okta-docs/providers/okta/group/apptargets/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapptargets
TypeResource
Idokta.group.apptargets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `features` | `array` | -| `displayName` | `string` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `signOnModes` | `array` | -| `_links` | `object` | -| `verificationStatus` | `string` | -| `category` | `string` | -| `website` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `groupId, roleId, subdomain` | Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID. | -| `insert` | `INSERT` | `appName, groupId, roleId, subdomain` | Success | -| `delete` | `DELETE` | `appName, groupId, roleId, subdomain` | Success | +| | `SELECT` | | Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID. | +| | `INSERT` | | Success | +| | `DELETE` | | Success | diff --git a/docs/okta-docs/providers/okta/group/groups/index.md b/docs/okta-docs/providers/okta/group/groups/index.md index 345c6ddf9e..b7608bd395 100644 --- a/docs/okta-docs/providers/okta/group/groups/index.md +++ b/docs/okta-docs/providers/okta/group/groups/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegroups
TypeResource
Idokta.group.groups
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `created` | `string` | -| `profile` | `object` | -| `lastMembershipUpdated` | `string` | -| `objectClass` | `array` | -| `_links` | `object` | -| `_embedded` | `object` | -| `type` | `string` | -| `lastUpdated` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `groupId, subdomain` | Fetches a group from your organization. | -| `list` | `SELECT` | `subdomain` | Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query. | -| `insert` | `INSERT` | `subdomain` | Adds a new group with `OKTA_GROUP` type to your organization. | -| `delete` | `DELETE` | `groupId, subdomain` | Removes a group with `OKTA_GROUP` type from your organization. | -| `update` | `EXEC` | `groupId, subdomain` | Updates the profile for a group with `OKTA_GROUP` type from your organization. | +| | `SELECT` | | Fetches a group from your organization. | +| | `SELECT` | | Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query. | +| | `INSERT` | | Adds a new group with `OKTA_GROUP` type to your organization. | +| | `DELETE` | | Removes a group with `OKTA_GROUP` type from your organization. | +| | `EXEC` | | Updates the profile for a group with `OKTA_GROUP` type from your organization. | diff --git a/docs/okta-docs/providers/okta/group/grouptargets/index.md b/docs/okta-docs/providers/okta/group/grouptargets/index.md index 27e10eacc5..7c689411c6 100644 --- a/docs/okta-docs/providers/okta/group/grouptargets/index.md +++ b/docs/okta-docs/providers/okta/group/grouptargets/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegrouptargets
TypeResource
Idokta.group.grouptargets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `type` | `string` | -| `_embedded` | `object` | -| `created` | `string` | -| `profile` | `object` | -| `objectClass` | `array` | -| `lastMembershipUpdated` | `string` | -| `_links` | `object` | -| `lastUpdated` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `groupId, roleId, subdomain` | Success | -| `insert` | `INSERT` | `groupId, roleId, targetGroupId, subdomain` | | -| `delete` | `DELETE` | `groupId, roleId, targetGroupId, subdomain` | | +| | `SELECT` | | Success | +| | `INSERT` | | | +| | `DELETE` | | | diff --git a/docs/okta-docs/providers/okta/group/index.md b/docs/okta-docs/providers/okta/group/index.md index f2e4e79d5a..8ffc4cef73 100644 --- a/docs/okta-docs/providers/okta/group/index.md +++ b/docs/okta-docs/providers/okta/group/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta group management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/group/roles/index.md b/docs/okta-docs/providers/okta/group/roles/index.md index 4bbebb6e5d..3fe266c152 100644 --- a/docs/okta-docs/providers/okta/group/roles/index.md +++ b/docs/okta-docs/providers/okta/group/roles/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroles
TypeResource
Idokta.group.roles
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `description` | `string` | -| `type` | `string` | -| `_links` | `object` | -| `created` | `string` | -| `lastUpdated` | `string` | -| `_embedded` | `object` | -| `label` | `string` | -| `status` | `string` | -| `assignmentType` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `groupId, roleId, subdomain` | Success | -| `list` | `SELECT` | `groupId, subdomain` | Success | -| `insert` | `INSERT` | `groupId, subdomain` | Assigns a Role to a Group | -| `delete` | `DELETE` | `groupId, roleId, subdomain` | Unassigns a Role from a Group | +| | `SELECT` | | Success | +| | `SELECT` | | Success | +| | `INSERT` | | Assigns a Role to a Group | +| | `DELETE` | | Unassigns a Role from a Group | diff --git a/docs/okta-docs/providers/okta/group/ruleactivations/index.md b/docs/okta-docs/providers/okta/group/ruleactivations/index.md index e0c3d6ce48..58f0de6829 100644 --- a/docs/okta-docs/providers/okta/group/ruleactivations/index.md +++ b/docs/okta-docs/providers/okta/group/ruleactivations/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameruleactivations
TypeResource
Idokta.group.ruleactivations
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `insert` | `INSERT` | `ruleId, subdomain` | Activates a specific group rule by id from your organization | -| `delete` | `DELETE` | `ruleId, subdomain` | Deactivates a specific group rule by id from your organization | +| | `INSERT` | | Activates a specific group rule by id from your organization | +| | `DELETE` | | Deactivates a specific group rule by id from your organization | diff --git a/docs/okta-docs/providers/okta/group/rules/index.md b/docs/okta-docs/providers/okta/group/rules/index.md index ab87e35ee5..4a7b397cf7 100644 --- a/docs/okta-docs/providers/okta/group/rules/index.md +++ b/docs/okta-docs/providers/okta/group/rules/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idokta.group.rules
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `status` | `string` | -| `type` | `string` | -| `actions` | `object` | -| `conditions` | `object` | -| `created` | `string` | -| `lastUpdated` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `ruleId, subdomain` | Fetches a specific group rule by id from your organization | -| `list` | `SELECT` | `subdomain` | Lists all group rules for your organization. | -| `insert` | `INSERT` | `subdomain` | Creates a group rule to dynamically add users to the specified group if they match the condition | -| `delete` | `DELETE` | `ruleId, subdomain` | Removes a specific group rule by id from your organization | -| `update` | `EXEC` | `ruleId, subdomain` | Updates a group rule. Only `INACTIVE` rules can be updated. | +| | `SELECT` | | Fetches a specific group rule by id from your organization | +| | `SELECT` | | Lists all group rules for your organization. | +| | `INSERT` | | Creates a group rule to dynamically add users to the specified group if they match the condition | +| | `DELETE` | | Removes a specific group rule by id from your organization | +| | `EXEC` | | Updates a group rule. Only `INACTIVE` rules can be updated. | diff --git a/docs/okta-docs/providers/okta/group/users/index.md b/docs/okta-docs/providers/okta/group/users/index.md index b379b3d246..3460ab2ab4 100644 --- a/docs/okta-docs/providers/okta/group/users/index.md +++ b/docs/okta-docs/providers/okta/group/users/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idokta.group.users
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `status` | `string` | -| `created` | `string` | -| `statusChanged` | `string` | -| `credentials` | `object` | -| `lastLogin` | `string` | -| `profile` | `object` | -| `_links` | `object` | -| `activated` | `string` | -| `transitioningToStatus` | `string` | -| `type` | `object` | -| `lastUpdated` | `string` | -| `_embedded` | `object` | -| `passwordChanged` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `groupId, subdomain` | Enumerates all users that are a member of a group. | -| `insert` | `INSERT` | `groupId, userId, subdomain` | Adds a user to a group with 'OKTA_GROUP' type. | -| `delete` | `DELETE` | `groupId, userId, subdomain` | Removes a user from a group with 'OKTA_GROUP' type. | +| | `SELECT` | | Enumerates all users that are a member of a group. | +| | `INSERT` | | Adds a user to a group with 'OKTA_GROUP' type. | +| | `DELETE` | | Removes a user from a group with 'OKTA_GROUP' type. | diff --git a/docs/okta-docs/providers/okta/groupschema/default/index.md b/docs/okta-docs/providers/okta/groupschema/default/index.md index 4f1c083604..7d25ea9208 100644 --- a/docs/okta-docs/providers/okta/groupschema/default/index.md +++ b/docs/okta-docs/providers/okta/groupschema/default/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedefault
TypeResource
Idokta.groupschema.default
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `lastUpdated` | `string` | -| `_links` | `object` | -| `title` | `string` | -| `created` | `string` | -| `type` | `string` | -| `properties` | `object` | -| `definitions` | `object` | -| `$schema` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subdomain` | Fetches the group schema | -| `update` | `EXEC` | `subdomain` | Updates, adds ore removes one or more custom Group Profile properties in the schema | +| | `SELECT` | | Fetches the group schema | +| | `EXEC` | | Updates, adds ore removes one or more custom Group Profile properties in the schema | diff --git a/docs/okta-docs/providers/okta/groupschema/index.md b/docs/okta-docs/providers/okta/groupschema/index.md index f8609e2d5d..ac5c810bb4 100644 --- a/docs/okta-docs/providers/okta/groupschema/index.md +++ b/docs/okta-docs/providers/okta/groupschema/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta group schema management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/identityprovider/csrs/index.md b/docs/okta-docs/providers/okta/identityprovider/csrs/index.md index 45d27a1a82..8f3b024542 100644 --- a/docs/okta-docs/providers/okta/identityprovider/csrs/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/csrs/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecsrs
TypeResource
Idokta.identityprovider.csrs
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `kty` | `string` | -| `created` | `string` | -| `csr` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `csrId, idpId, subdomain` | Gets a specific Certificate Signing Request model by id | -| `list` | `SELECT` | `idpId, subdomain` | Enumerates Certificate Signing Requests for an IdP | -| `insert` | `INSERT` | `idpId, subdomain` | Generates a new key pair and returns a Certificate Signing Request for it. | -| `delete` | `DELETE` | `csrId, idpId, subdomain` | Revoke a Certificate Signing Request and delete the key pair from the IdP | +| | `SELECT` | | Gets a specific Certificate Signing Request model by id | +| | `SELECT` | | Enumerates Certificate Signing Requests for an IdP | +| | `INSERT` | | Generates a new key pair and returns a Certificate Signing Request for it. | +| | `DELETE` | | Revoke a Certificate Signing Request and delete the key pair from the IdP | diff --git a/docs/okta-docs/providers/okta/identityprovider/idpkeys/index.md b/docs/okta-docs/providers/okta/identityprovider/idpkeys/index.md index 997338ddc5..554380c24a 100644 --- a/docs/okta-docs/providers/okta/identityprovider/idpkeys/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/idpkeys/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidpkeys
TypeResource
Idokta.identityprovider.idpkeys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `key_ops` | `array` | -| `lastUpdated` | `string` | -| `kty` | `string` | -| `false` | `string` | -| `status` | `string` | -| `x5t` | `string` | -| `_links` | `object` | -| `x5t#S256` | `string` | -| `kid` | `string` | -| `alg` | `string` | -| `created` | `string` | -| `expiresAt` | `string` | -| `x5c` | `array` | -| `e` | `string` | -| `x5u` | `string` | -| `use` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `idpId, keyId, subdomain` | Gets a specific IdP Key Credential by `kid` | -| `list` | `SELECT` | `idpId, subdomain` | Enumerates signing key credentials for an IdP | -| `insert` | `INSERT` | `idpId, validityYears, subdomain` | Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP | -| `clone` | `EXEC` | `idpId, keyId, targetIdpId, subdomain` | Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP | +| | `SELECT` | | Gets a specific IdP Key Credential by `kid` | +| | `SELECT` | | Enumerates signing key credentials for an IdP | +| | `INSERT` | | Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP | +| | `EXEC` | | Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP | diff --git a/docs/okta-docs/providers/okta/identityprovider/idps/index.md b/docs/okta-docs/providers/okta/identityprovider/idps/index.md index ac92e322f8..ea9a1d5f71 100644 --- a/docs/okta-docs/providers/okta/identityprovider/idps/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/idps/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidps
TypeResource
Idokta.identityprovider.idps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `protocol` | `object` | -| `issuerMode` | `string` | -| `_links` | `object` | -| `policy` | `object` | -| `type` | `string` | -| `created` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `idpId, subdomain` | Fetches an IdP by `id`. | -| `list` | `SELECT` | `subdomain` | Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query. | -| `insert` | `INSERT` | `subdomain` | Adds a new IdP to your organization. | -| `delete` | `DELETE` | `idpId, subdomain` | Removes an IdP from your organization. | -| `activate` | `EXEC` | `idpId, subdomain` | Activates an inactive IdP. | -| `deactivate` | `EXEC` | `idpId, subdomain` | Activates an inactive IdP. | -| `update` | `EXEC` | `idpId, subdomain` | Updates the configuration for an IdP. | +| | `SELECT` | | Fetches an IdP by `id`. | +| | `SELECT` | | Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query. | +| | `INSERT` | | Adds a new IdP to your organization. | +| | `DELETE` | | Removes an IdP from your organization. | +| | `EXEC` | | Activates an inactive IdP. | +| | `EXEC` | | Activates an inactive IdP. | +| | `EXEC` | | Updates the configuration for an IdP. | diff --git a/docs/okta-docs/providers/okta/identityprovider/index.md b/docs/okta-docs/providers/okta/identityprovider/index.md index 4701d12745..95a8ec8c60 100644 --- a/docs/okta-docs/providers/okta/identityprovider/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta user management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/identityprovider/keys/index.md b/docs/okta-docs/providers/okta/identityprovider/keys/index.md index 05b7b4aa14..d21cc664ac 100644 --- a/docs/okta-docs/providers/okta/identityprovider/keys/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/keys/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namekeys
TypeResource
Idokta.identityprovider.keys
Id
## Fields | Name | Datatype | |:-----|:---------| -| `x5u` | `string` | -| `created` | `string` | -| `x5t` | `string` | -| `_links` | `object` | -| `false` | `string` | -| `use` | `string` | -| `key_ops` | `array` | -| `e` | `string` | -| `kty` | `string` | -| `kid` | `string` | -| `alg` | `string` | -| `status` | `string` | -| `x5c` | `array` | -| `lastUpdated` | `string` | -| `expiresAt` | `string` | -| `x5t#S256` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `keyId, subdomain` | Gets a specific IdP Key Credential by `kid` | -| `list` | `SELECT` | `subdomain` | Enumerates IdP key credentials. | -| `insert` | `INSERT` | `subdomain` | Adds a new X.509 certificate credential to the IdP key store. | -| `delete` | `DELETE` | `keyId, subdomain` | Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP. | +| | `SELECT` | | Gets a specific IdP Key Credential by `kid` | +| | `SELECT` | | Enumerates IdP key credentials. | +| | `INSERT` | | Adds a new X.509 certificate credential to the IdP key store. | +| | `DELETE` | | Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP. | diff --git a/docs/okta-docs/providers/okta/identityprovider/users/index.md b/docs/okta-docs/providers/okta/identityprovider/users/index.md index a5f703a200..e423c16edf 100644 --- a/docs/okta-docs/providers/okta/identityprovider/users/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/users/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idokta.identityprovider.users
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `_embedded` | `object` | -| `_links` | `object` | -| `created` | `string` | -| `externalId` | `string` | -| `lastUpdated` | `string` | -| `profile` | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `idpId, userId, subdomain` | Fetches a linked IdP user by ID | -| `list` | `SELECT` | `idpId, subdomain` | Find all the users linked to an identity provider | -| `insert` | `INSERT` | `idpId, userId, subdomain` | Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type | -| `delete` | `DELETE` | `idpId, userId, subdomain` | Removes the link between the Okta user and the IdP user. | +| | `SELECT` | | Fetches a linked IdP user by ID | +| | `SELECT` | | Find all the users linked to an identity provider | +| | `INSERT` | | Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type | +| | `DELETE` | | Removes the link between the Okta user and the IdP user. | diff --git a/docs/okta-docs/providers/okta/identityprovider/usertokens/index.md b/docs/okta-docs/providers/okta/identityprovider/usertokens/index.md index d428b2979a..65d20a1da8 100644 --- a/docs/okta-docs/providers/okta/identityprovider/usertokens/index.md +++ b/docs/okta-docs/providers/okta/identityprovider/usertokens/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusertokens
TypeResource
Idokta.identityprovider.usertokens
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `tokenAuthScheme` | `string` | -| `tokenType` | `string` | -| `expiresAt` | `string` | -| `scopes` | `array` | -| `token` | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `idpId, userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/inlinehook/idps/index.md b/docs/okta-docs/providers/okta/inlinehook/idps/index.md index cbf5d88b5f..a5b5147bc4 100644 --- a/docs/okta-docs/providers/okta/inlinehook/idps/index.md +++ b/docs/okta-docs/providers/okta/inlinehook/idps/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidps
TypeResource
Idokta.inlinehook.idps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `created` | `string` | -| `type` | `string` | -| `version` | `string` | -| `channel` | `object` | -| `status` | `string` | -| `_links` | `object` | -| `lastUpdated` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `inlineHookId, subdomain` | Gets an inline hook by ID | -| `list` | `SELECT` | `subdomain` | Success | -| `insert` | `INSERT` | `subdomain` | Success | -| `delete` | `DELETE` | `inlineHookId, subdomain` | Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion. | -| `activate` | `EXEC` | `inlineHookId, subdomain` | Activates the Inline Hook matching the provided id | -| `deactivate` | `EXEC` | `inlineHookId, subdomain` | Deactivates the Inline Hook matching the provided id | -| `execute` | `EXEC` | `inlineHookId, subdomain` | Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes. | -| `update` | `EXEC` | `inlineHookId, subdomain` | Updates an inline hook by ID | +| | `SELECT` | | Gets an inline hook by ID | +| | `SELECT` | | Success | +| | `INSERT` | | Success | +| | `DELETE` | | Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion. | +| | `EXEC` | | Activates the Inline Hook matching the provided id | +| | `EXEC` | | Deactivates the Inline Hook matching the provided id | +| | `EXEC` | | Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes. | +| | `EXEC` | | Updates an inline hook by ID | diff --git a/docs/okta-docs/providers/okta/inlinehook/index.md b/docs/okta-docs/providers/okta/inlinehook/index.md index 2345e0ff40..bdb5048c1a 100644 --- a/docs/okta-docs/providers/okta/inlinehook/index.md +++ b/docs/okta-docs/providers/okta/inlinehook/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta inline hook management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/linkedobject/idps/index.md b/docs/okta-docs/providers/okta/linkedobject/idps/index.md index 8bdbfec023..32a26f0f8e 100644 --- a/docs/okta-docs/providers/okta/linkedobject/idps/index.md +++ b/docs/okta-docs/providers/okta/linkedobject/idps/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidps
TypeResource
Idokta.linkedobject.idps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `_links` | `object` | -| `associated` | `object` | -| `primary` | `object` | +| | `object` | +| | `object` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `linkedObjectName, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `insert` | `INSERT` | `subdomain` | -| `delete` | `DELETE` | `linkedObjectName, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | diff --git a/docs/okta-docs/providers/okta/linkedobject/index.md b/docs/okta-docs/providers/okta/linkedobject/index.md index 63b59f7831..b60f257238 100644 --- a/docs/okta-docs/providers/okta/linkedobject/index.md +++ b/docs/okta-docs/providers/okta/linkedobject/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta linked object management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/log/index.md b/docs/okta-docs/providers/okta/log/index.md index 3e46c39730..d03e04052d 100644 --- a/docs/okta-docs/providers/okta/log/index.md +++ b/docs/okta-docs/providers/okta/log/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta log management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/log/logs/index.md b/docs/okta-docs/providers/okta/log/logs/index.md index e8c9724547..6a1fb25fe7 100644 --- a/docs/okta-docs/providers/okta/log/logs/index.md +++ b/docs/okta-docs/providers/okta/log/logs/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelogs
TypeResource
Idokta.log.logs
Id
## Fields | Name | Datatype | |:-----|:---------| -| `uuid` | `string` | -| `eventType` | `string` | -| `published` | `string` | -| `target` | `array` | -| `outcome` | `object` | -| `debugContext` | `object` | -| `securityContext` | `object` | -| `severity` | `string` | -| `transaction` | `object` | -| `authenticationContext` | `object` | -| `actor` | `object` | -| `client` | `object` | -| `request` | `object` | -| `version` | `string` | -| `displayMessage` | `string` | -| `legacyEventType` | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `array` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/networkzone/index.md b/docs/okta-docs/providers/okta/networkzone/index.md index b11e0f0f3b..503894fe3d 100644 --- a/docs/okta-docs/providers/okta/networkzone/index.md +++ b/docs/okta-docs/providers/okta/networkzone/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta network zone management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/networkzone/zones/index.md b/docs/okta-docs/providers/okta/networkzone/zones/index.md index de70a7d46f..5ab284dd47 100644 --- a/docs/okta-docs/providers/okta/networkzone/zones/index.md +++ b/docs/okta-docs/providers/okta/networkzone/zones/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namezones
TypeResource
Idokta.networkzone.zones
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `locations` | `array` | -| `system` | `boolean` | -| `status` | `string` | -| `proxyType` | `string` | -| `gateways` | `array` | -| `created` | `string` | -| `proxies` | `array` | -| `_links` | `object` | -| `type` | `string` | -| `usage` | `string` | -| `lastUpdated` | `string` | -| `asns` | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `array` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `zoneId, subdomain` | Fetches a network zone from your Okta organization by `id`. | -| `list` | `SELECT` | `subdomain` | Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query. | -| `insert` | `INSERT` | `subdomain` | Adds a new network zone to your Okta organization. | -| `delete` | `DELETE` | `zoneId, subdomain` | Removes network zone. | -| `activate` | `EXEC` | `zoneId, subdomain` | Activate Network Zone | -| `deactivate` | `EXEC` | `zoneId, subdomain` | Deactivates a network zone. | -| `update` | `EXEC` | `zoneId, subdomain` | Updates a network zone in your organization. | +| | `SELECT` | | Fetches a network zone from your Okta organization by `id`. | +| | `SELECT` | | Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query. | +| | `INSERT` | | Adds a new network zone to your Okta organization. | +| | `DELETE` | | Removes network zone. | +| | `EXEC` | | Activate Network Zone | +| | `EXEC` | | Deactivates a network zone. | +| | `EXEC` | | Updates a network zone in your organization. | diff --git a/docs/okta-docs/providers/okta/org/contacts/index.md b/docs/okta-docs/providers/okta/org/contacts/index.md index 4f08d2cfe6..83ca3fc4b3 100644 --- a/docs/okta-docs/providers/okta/org/contacts/index.md +++ b/docs/okta-docs/providers/okta/org/contacts/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontacts
TypeResource
Idokta.org.contacts
Id
## Fields | Name | Datatype | |:-----|:---------| -| `_links` | `object` | -| `contactType` | `string` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `contactType, subdomain` | Retrieves the URL of the User associated with the specified Contact Type. | -| `list` | `SELECT` | `subdomain` | Gets Contact Types of your organization. | -| `update` | `EXEC` | `contactType, subdomain` | Updates the User associated with the specified Contact Type. | +| | `SELECT` | | Retrieves the URL of the User associated with the specified Contact Type. | +| | `SELECT` | | Gets Contact Types of your organization. | +| | `EXEC` | | Updates the User associated with the specified Contact Type. | diff --git a/docs/okta-docs/providers/okta/org/index.md b/docs/okta-docs/providers/okta/org/index.md index 4c527a30a9..3ac2d639dc 100644 --- a/docs/okta-docs/providers/okta/org/index.md +++ b/docs/okta-docs/providers/okta/org/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta org management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/org/oktacommunication/index.md b/docs/okta-docs/providers/okta/org/oktacommunication/index.md index 650f696a48..8f4ad8c262 100644 --- a/docs/okta-docs/providers/okta/org/oktacommunication/index.md +++ b/docs/okta-docs/providers/okta/org/oktacommunication/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoktacommunication
TypeResource
Idokta.org.oktacommunication
Id
## Fields | Name | Datatype | |:-----|:---------| -| `_links` | `object` | -| `optOutEmailUsers` | `boolean` | +| | `object` | +| | `boolean` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subdomain` | Gets Okta Communication Settings of your organization. | -| `optIn` | `EXEC` | `subdomain` | Opts in all users of this org to Okta Communication emails. | -| `optOut` | `EXEC` | `subdomain` | Opts out all users of this org from Okta Communication emails. | +| | `SELECT` | | Gets Okta Communication Settings of your organization. | +| | `EXEC` | | Opts in all users of this org to Okta Communication emails. | +| | `EXEC` | | Opts out all users of this org from Okta Communication emails. | diff --git a/docs/okta-docs/providers/okta/org/oktasupport/index.md b/docs/okta-docs/providers/okta/org/oktasupport/index.md index 0ef4885469..8b4b4fdf94 100644 --- a/docs/okta-docs/providers/okta/org/oktasupport/index.md +++ b/docs/okta-docs/providers/okta/org/oktasupport/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoktasupport
TypeResource
Idokta.org.oktasupport
Id
## Fields | Name | Datatype | |:-----|:---------| -| `_links` | `object` | -| `expiration` | `string` | -| `support` | `string` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subdomain` | Gets Okta Support Settings of your organization. | -| `extend` | `EXEC` | `subdomain` | Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time. | -| `grant` | `EXEC` | `subdomain` | Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours. | -| `revoke` | `EXEC` | `subdomain` | Revokes Okta Support access to your organization. | +| | `SELECT` | | Gets Okta Support Settings of your organization. | +| | `EXEC` | | Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time. | +| | `EXEC` | | Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours. | +| | `EXEC` | | Revokes Okta Support access to your organization. | diff --git a/docs/okta-docs/providers/okta/org/org/index.md b/docs/okta-docs/providers/okta/org/org/index.md index 27c92f11ff..385f78b007 100644 --- a/docs/okta-docs/providers/okta/org/org/index.md +++ b/docs/okta-docs/providers/okta/org/org/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameorg
TypeResource
Idokta.org.org
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `subdomain` | `string` | -| `status` | `string` | -| `endUserSupportHelpURL` | `string` | -| `state` | `string` | -| `address2` | `string` | -| `created` | `string` | -| `website` | `string` | -| `companyName` | `string` | -| `postalCode` | `string` | -| `supportPhoneNumber` | `string` | -| `address1` | `string` | -| `phoneNumber` | `string` | -| `country` | `string` | -| `expiresAt` | `string` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `city` | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subdomain` | Get settings of your organization. | -| `partialUpdate` | `EXEC` | `subdomain` | Partial update settings of your organization. | -| `update` | `EXEC` | `subdomain` | Update settings of your organization. | +| | `SELECT` | | Get settings of your organization. | +| | `EXEC` | | Partial update settings of your organization. | +| | `EXEC` | | Update settings of your organization. | diff --git a/docs/okta-docs/providers/okta/org/preferences/index.md b/docs/okta-docs/providers/okta/org/preferences/index.md index 18e58e5b3e..12b40b64f0 100644 --- a/docs/okta-docs/providers/okta/org/preferences/index.md +++ b/docs/okta-docs/providers/okta/org/preferences/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepreferences
TypeResource
Idokta.org.preferences
Id
## Fields | Name | Datatype | |:-----|:---------| -| `_links` | `object` | -| `showEndUserFooter` | `boolean` | +| | `object` | +| | `boolean` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subdomain` | Gets preferences of your organization. | -| `hideEndUserFooter` | `EXEC` | `subdomain` | Hide the Okta UI footer for all end users of your organization. | -| `showEndUserFooter` | `EXEC` | `subdomain` | Makes the Okta UI footer visible for all end users of your organization. | +| | `SELECT` | | Gets preferences of your organization. | +| | `EXEC` | | Hide the Okta UI footer for all end users of your organization. | +| | `EXEC` | | Makes the Okta UI footer visible for all end users of your organization. | diff --git a/docs/okta-docs/providers/okta/policy/index.md b/docs/okta-docs/providers/okta/policy/index.md index d44c1d9d30..12306455ec 100644 --- a/docs/okta-docs/providers/okta/policy/index.md +++ b/docs/okta-docs/providers/okta/policy/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta policy management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/policy/policies/index.md b/docs/okta-docs/providers/okta/policy/policies/index.md index 423b535223..b7d8846af9 100644 --- a/docs/okta-docs/providers/okta/policy/policies/index.md +++ b/docs/okta-docs/providers/okta/policy/policies/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepolicies
TypeResource
Idokta.policy.policies
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `conditions` | `object` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `type` | `string` | -| `_embedded` | `object` | -| `priority` | `integer` | -| `system` | `boolean` | -| `created` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `policyId, subdomain` | Gets a policy. | -| `list` | `SELECT` | `type, subdomain` | Gets all policies with the specified type. | -| `insert` | `INSERT` | `subdomain` | Creates a policy. | -| `delete` | `DELETE` | `policyId, subdomain` | Removes a policy. | -| `activate` | `EXEC` | `policyId, ruleId, subdomain` | Activates a policy rule. | -| `deactivate` | `EXEC` | `policyId, ruleId, subdomain` | Deactivates a policy rule. | +| | `SELECT` | | Gets a policy. | +| | `SELECT` | | Gets all policies with the specified type. | +| | `INSERT` | | Creates a policy. | +| | `DELETE` | | Removes a policy. | +| | `EXEC` | | Activates a policy rule. | +| | `EXEC` | | Deactivates a policy rule. | diff --git a/docs/okta-docs/providers/okta/policy/rules/index.md b/docs/okta-docs/providers/okta/policy/rules/index.md index 16f575bd59..9515e37318 100644 --- a/docs/okta-docs/providers/okta/policy/rules/index.md +++ b/docs/okta-docs/providers/okta/policy/rules/index.md @@ -14,38 +14,41 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idokta.policy.rules
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `_embedded` | `object` | -| `lastUpdated` | `string` | -| `system` | `boolean` | -| `priority` | `integer` | -| `conditions` | `object` | -| `_links` | `object` | -| `type` | `string` | -| `created` | `string` | -| `status` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `policyId, ruleId, subdomain` | Gets a policy rule. | -| `list` | `SELECT` | `type, subdomain` | Gets all policies with the specified type. | -| `insert` | `INSERT` | `policyId, subdomain` | Creates a policy rule. | -| `delete` | `DELETE` | `policyId, ruleId, subdomain` | Removes a policy rule. | -| `activate` | `EXEC` | `policyId, ruleId, subdomain` | Activates a policy rule. | -| `deactivate` | `EXEC` | `policyId, ruleId, subdomain` | Deactivates a policy rule. | -| `put` | `EXEC` | `policyId, ruleId, subdomain` | Updates a policy rule. | +| | `SELECT` | | Gets a policy rule. | +| | `SELECT` | | Gets all policies with the specified type. | +| | `INSERT` | | Creates a policy rule. | +| | `DELETE` | | Removes a policy rule. | +| | `EXEC` | | Activates a policy rule. | +| | `EXEC` | | Deactivates a policy rule. | +| | `EXEC` | | Updates a policy rule. | diff --git a/docs/okta-docs/providers/okta/profilemapping/index.md b/docs/okta-docs/providers/okta/profilemapping/index.md index 6b70ffe79b..943bc2cb88 100644 --- a/docs/okta-docs/providers/okta/profilemapping/index.md +++ b/docs/okta-docs/providers/okta/profilemapping/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta profile mapping management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/profilemapping/mappings/index.md b/docs/okta-docs/providers/okta/profilemapping/mappings/index.md index 15e5258d77..4f54ef04d0 100644 --- a/docs/okta-docs/providers/okta/profilemapping/mappings/index.md +++ b/docs/okta-docs/providers/okta/profilemapping/mappings/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemappings
TypeResource
Idokta.profilemapping.mappings
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `source` | `object` | -| `target` | `object` | -| `_links` | `object` | -| `properties` | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `mappingId, subdomain` | Fetches a single Profile Mapping referenced by its ID. | -| `list` | `SELECT` | `subdomain` | Enumerates Profile Mappings in your organization with pagination. | -| `insert` | `INSERT` | `mappingId, subdomain` | Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings. | +| | `SELECT` | | Fetches a single Profile Mapping referenced by its ID. | +| | `SELECT` | | Enumerates Profile Mappings in your organization with pagination. | +| | `INSERT` | | Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings. | diff --git a/docs/okta-docs/providers/okta/session/index.md b/docs/okta-docs/providers/okta/session/index.md index c04310b2be..7985c30796 100644 --- a/docs/okta-docs/providers/okta/session/index.md +++ b/docs/okta-docs/providers/okta/session/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta session management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/session/sessions/index.md b/docs/okta-docs/providers/okta/session/sessions/index.md index 54216df0a3..876d3619f6 100644 --- a/docs/okta-docs/providers/okta/session/sessions/index.md +++ b/docs/okta-docs/providers/okta/session/sessions/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesessions
TypeResource
Idokta.session.sessions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `idp` | `object` | -| `lastPasswordVerification` | `string` | -| `expiresAt` | `string` | -| `status` | `string` | -| `login` | `string` | -| `_links` | `object` | -| `lastFactorVerification` | `string` | -| `amr` | `array` | -| `createdAt` | `string` | -| `userId` | `string` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `sessionId, subdomain` | Get details about a session. | -| `insert` | `INSERT` | `subdomain` | Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL. | -| `delete` | `DELETE` | `sessionId, subdomain` | | -| `refresh` | `EXEC` | `sessionId, subdomain` | | +| | `SELECT` | | Get details about a session. | +| | `INSERT` | | Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL. | +| | `DELETE` | | | +| | `EXEC` | | | diff --git a/docs/okta-docs/providers/okta/template/index.md b/docs/okta-docs/providers/okta/template/index.md index 3faab40bce..cb4718323a 100644 --- a/docs/okta-docs/providers/okta/template/index.md +++ b/docs/okta-docs/providers/okta/template/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta template management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/template/sms/index.md b/docs/okta-docs/providers/okta/template/sms/index.md index b488fc5fcc..492abd6465 100644 --- a/docs/okta-docs/providers/okta/template/sms/index.md +++ b/docs/okta-docs/providers/okta/template/sms/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesms
TypeResource
Idokta.template.sms
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `template` | `string` | -| `translations` | `object` | -| `type` | `string` | -| `created` | `string` | -| `lastUpdated` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `templateId, subdomain` | Fetches a specific template by `id` | -| `list` | `SELECT` | `subdomain` | Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type. | -| `insert` | `INSERT` | `subdomain` | Adds a new custom SMS template to your organization. | -| `delete` | `DELETE` | `templateId, subdomain` | Removes an SMS template. | -| `partialUpdate` | `EXEC` | `templateId, subdomain` | Updates only some of the SMS template properties: | -| `update` | `EXEC` | `templateId, subdomain` | Updates the SMS template. | +| | `SELECT` | | Fetches a specific template by `id` | +| | `SELECT` | | Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type. | +| | `INSERT` | | Adds a new custom SMS template to your organization. | +| | `DELETE` | | Removes an SMS template. | +| | `EXEC` | | Updates only some of the SMS template properties: | +| | `EXEC` | | Updates the SMS template. | diff --git a/docs/okta-docs/providers/okta/threatinsight/configuration/index.md b/docs/okta-docs/providers/okta/threatinsight/configuration/index.md index 14e91c435c..7417e05c49 100644 --- a/docs/okta-docs/providers/okta/threatinsight/configuration/index.md +++ b/docs/okta-docs/providers/okta/threatinsight/configuration/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfiguration
TypeResource
Idokta.threatinsight.configuration
Id
## Fields | Name | Datatype | |:-----|:---------| -| `created` | `string` | -| `excludeZones` | `array` | -| `lastUpdated` | `string` | -| `_links` | `object` | -| `action` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/threatinsight/index.md b/docs/okta-docs/providers/okta/threatinsight/index.md index 107ea1adca..deb7753048 100644 --- a/docs/okta-docs/providers/okta/threatinsight/index.md +++ b/docs/okta-docs/providers/okta/threatinsight/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta threat insight management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/trustedorigin/index.md b/docs/okta-docs/providers/okta/trustedorigin/index.md index 6de3dc2be4..9581b7252f 100644 --- a/docs/okta-docs/providers/okta/trustedorigin/index.md +++ b/docs/okta-docs/providers/okta/trustedorigin/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta threat insight management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/trustedorigin/trustedorigins/index.md b/docs/okta-docs/providers/okta/trustedorigin/trustedorigins/index.md index f5c4a30dd8..15dd165150 100644 --- a/docs/okta-docs/providers/okta/trustedorigin/trustedorigins/index.md +++ b/docs/okta-docs/providers/okta/trustedorigin/trustedorigins/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametrustedorigins
TypeResource
Idokta.trustedorigin.trustedorigins
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `lastUpdatedBy` | `string` | -| `created` | `string` | -| `status` | `string` | -| `origin` | `string` | -| `_links` | `object` | -| `createdBy` | `string` | -| `lastUpdated` | `string` | -| `scopes` | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `trustedOriginId, subdomain` | -| `list` | `SELECT` | `subdomain` | -| `insert` | `INSERT` | `subdomain` | -| `delete` | `DELETE` | `trustedOriginId, subdomain` | -| `activate` | `EXEC` | `trustedOriginId, subdomain` | -| `deactivate` | `EXEC` | `trustedOriginId, subdomain` | -| `update` | `EXEC` | `trustedOriginId, subdomain` | +| | `SELECT` | | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | +| | `EXEC` | | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/okta-docs/providers/okta/user/appadmintargets/index.md b/docs/okta-docs/providers/okta/user/appadmintargets/index.md index b5c51d6136..96948f069a 100644 --- a/docs/okta-docs/providers/okta/user/appadmintargets/index.md +++ b/docs/okta-docs/providers/okta/user/appadmintargets/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameappadmintargets
TypeResource
Idokta.user.appadmintargets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `displayName` | `string` | -| `features` | `array` | -| `signOnModes` | `array` | -| `status` | `string` | -| `website` | `string` | -| `lastUpdated` | `string` | -| `category` | `string` | -| `_links` | `object` | -| `verificationStatus` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `roleId, userId, subdomain` | Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID. | -| `insert` | `INSERT` | `appName, applicationId, roleId, userId, subdomain` | Add App Instance Target to App Administrator Role given to a User | -| `delete` | `DELETE` | `appName, applicationId, roleId, userId, subdomain` | Remove App Instance Target to App Administrator Role given to a User | +| | `SELECT` | | Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID. | +| | `INSERT` | | Add App Instance Target to App Administrator Role given to a User | +| | `DELETE` | | Remove App Instance Target to App Administrator Role given to a User | diff --git a/docs/okta-docs/providers/okta/user/appadmintargetsall/index.md b/docs/okta-docs/providers/okta/user/appadmintargetsall/index.md index f5ca82f516..f4f9494670 100644 --- a/docs/okta-docs/providers/okta/user/appadmintargetsall/index.md +++ b/docs/okta-docs/providers/okta/user/appadmintargetsall/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameappadmintargetsall
TypeResource
Idokta.user.appadmintargetsall
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `insert` | `INSERT` | `roleId, userId, subdomain` | +| | `INSERT` | | diff --git a/docs/okta-docs/providers/okta/user/appinstanceadmintargets/index.md b/docs/okta-docs/providers/okta/user/appinstanceadmintargets/index.md index 9a436b689a..f56f9baa18 100644 --- a/docs/okta-docs/providers/okta/user/appinstanceadmintargets/index.md +++ b/docs/okta-docs/providers/okta/user/appinstanceadmintargets/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameappinstanceadmintargets
TypeResource
Idokta.user.appinstanceadmintargets
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `insert` | `INSERT` | `appName, applicationId, roleId, userId, subdomain` | Add App Instance Target to App Administrator Role given to a User | -| `delete` | `DELETE` | `appName, applicationId, roleId, userId, subdomain` | Remove App Instance Target to App Administrator Role given to a User | +| | `INSERT` | | Add App Instance Target to App Administrator Role given to a User | +| | `DELETE` | | Remove App Instance Target to App Administrator Role given to a User | diff --git a/docs/okta-docs/providers/okta/user/applinks/index.md b/docs/okta-docs/providers/okta/user/applinks/index.md index c63b28c17c..7236ea836f 100644 --- a/docs/okta-docs/providers/okta/user/applinks/index.md +++ b/docs/okta-docs/providers/okta/user/applinks/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapplinks
TypeResource
Idokta.user.applinks
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `label` | `string` | -| `appInstanceId` | `string` | -| `logoUrl` | `string` | -| `appName` | `string` | -| `linkUrl` | `string` | -| `sortOrder` | `integer` | -| `appAssignmentId` | `string` | -| `credentialsSetup` | `boolean` | -| `hidden` | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/user/clientgrants/index.md b/docs/okta-docs/providers/okta/user/clientgrants/index.md index 5fac5a4bc8..3c09b1a639 100644 --- a/docs/okta-docs/providers/okta/user/clientgrants/index.md +++ b/docs/okta-docs/providers/okta/user/clientgrants/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclientgrants
TypeResource
Idokta.user.clientgrants
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `clientId` | `string` | -| `lastUpdated` | `string` | -| `issuer` | `string` | -| `_embedded` | `object` | -| `_links` | `object` | -| `created` | `string` | -| `scopeId` | `string` | -| `source` | `string` | -| `createdBy` | `object` | -| `status` | `string` | -| `userId` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `clientId, userId, subdomain` | Lists all grants for a specified user and client | -| `delete` | `DELETE` | `clientId, userId, subdomain` | Revokes all grants for the specified user and client | +| | `SELECT` | | Lists all grants for a specified user and client | +| | `DELETE` | | Revokes all grants for the specified user and client | diff --git a/docs/okta-docs/providers/okta/user/clients/index.md b/docs/okta-docs/providers/okta/user/clients/index.md index 1fce138033..34cdcdfe00 100644 --- a/docs/okta-docs/providers/okta/user/clients/index.md +++ b/docs/okta-docs/providers/okta/user/clients/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclients
TypeResource
Idokta.user.clients
Id
## Fields | Name | Datatype | |:-----|:---------| -| `client_uri` | `string` | -| `logo_uri` | `string` | -| `_links` | `object` | -| `client_id` | `string` | -| `client_name` | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/user/clienttokens/index.md b/docs/okta-docs/providers/okta/user/clienttokens/index.md index 8c4383c07d..aad4206f22 100644 --- a/docs/okta-docs/providers/okta/user/clienttokens/index.md +++ b/docs/okta-docs/providers/okta/user/clienttokens/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameclienttokens
TypeResource
Idokta.user.clienttokens
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `userId` | `string` | -| `status` | `string` | -| `scopes` | `array` | -| `_embedded` | `object` | -| `clientId` | `string` | -| `lastUpdated` | `string` | -| `created` | `string` | -| `issuer` | `string` | -| `createdBy` | `object` | -| `expiresAt` | `string` | -| `_links` | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `clientId, tokenId, userId, subdomain` | Gets a refresh token issued for the specified User and Client. | -| `list` | `SELECT` | `clientId, userId, subdomain` | Lists all refresh tokens issued for the specified User and Client. | -| `delete` | `DELETE` | `clientId, tokenId, userId, subdomain` | Revokes the specified refresh token. | -| `deleteAll` | `EXEC` | `clientId, userId, subdomain` | Revokes all refresh tokens issued for the specified User and Client. | +| | `SELECT` | | Gets a refresh token issued for the specified User and Client. | +| | `SELECT` | | Lists all refresh tokens issued for the specified User and Client. | +| | `DELETE` | | Revokes the specified refresh token. | +| | `EXEC` | | Revokes all refresh tokens issued for the specified User and Client. | diff --git a/docs/okta-docs/providers/okta/user/grants/index.md b/docs/okta-docs/providers/okta/user/grants/index.md index 493f67db00..fd052658b0 100644 --- a/docs/okta-docs/providers/okta/user/grants/index.md +++ b/docs/okta-docs/providers/okta/user/grants/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegrants
TypeResource
Idokta.user.grants
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `_links` | `object` | -| `clientId` | `string` | -| `created` | `string` | -| `scopeId` | `string` | -| `userId` | `string` | -| `source` | `string` | -| `_embedded` | `object` | -| `createdBy` | `object` | -| `issuer` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `grantId, userId, subdomain` | Gets a grant for the specified user | -| `list` | `SELECT` | `userId, subdomain` | Lists all grants for the specified user | -| `delete` | `DELETE` | `grantId, userId, subdomain` | Revokes one grant for a specified user | -| `deleteAll` | `EXEC` | `userId, subdomain` | Revokes all grants for a specified user | +| | `SELECT` | | Gets a grant for the specified user | +| | `SELECT` | | Lists all grants for the specified user | +| | `DELETE` | | Revokes one grant for a specified user | +| | `EXEC` | | Revokes all grants for a specified user | diff --git a/docs/okta-docs/providers/okta/user/grouptargets/index.md b/docs/okta-docs/providers/okta/user/grouptargets/index.md index 2337f6dec3..30ec48f5e4 100644 --- a/docs/okta-docs/providers/okta/user/grouptargets/index.md +++ b/docs/okta-docs/providers/okta/user/grouptargets/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegrouptargets
TypeResource
Idokta.user.grouptargets
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `created` | `string` | -| `profile` | `object` | -| `type` | `string` | -| `lastMembershipUpdated` | `string` | -| `objectClass` | `array` | -| `_embedded` | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `roleId, userId, subdomain` | -| `insert` | `INSERT` | `groupId, roleId, userId, subdomain` | -| `delete` | `DELETE` | `groupId, roleId, userId, subdomain` | +| | `SELECT` | | +| | `INSERT` | | +| | `DELETE` | | diff --git a/docs/okta-docs/providers/okta/user/idps/index.md b/docs/okta-docs/providers/okta/user/idps/index.md index dabce75e0f..31a067da71 100644 --- a/docs/okta-docs/providers/okta/user/idps/index.md +++ b/docs/okta-docs/providers/okta/user/idps/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidps
TypeResource
Idokta.user.idps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `issuerMode` | `string` | -| `policy` | `object` | -| `created` | `string` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `protocol` | `object` | -| `_links` | `object` | -| `type` | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/user/index.md b/docs/okta-docs/providers/okta/user/index.md index 44241c5a0e..8569a8dc3f 100644 --- a/docs/okta-docs/providers/okta/user/index.md +++ b/docs/okta-docs/providers/okta/user/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta user management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/user/linkedobject/index.md b/docs/okta-docs/providers/okta/user/linkedobject/index.md index d6d245e86e..da49e4bc49 100644 --- a/docs/okta-docs/providers/okta/user/linkedobject/index.md +++ b/docs/okta-docs/providers/okta/user/linkedobject/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelinkedobject
TypeResource
Idokta.user.linkedobject
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `delete` | `DELETE` | `relationshipName, userId, subdomain` | Delete linked objects for a user, relationshipName can be ONLY a primary relationship name | -| `update` | `EXEC` | `associatedUserId, primaryRelationshipName, primaryUserId, subdomain` | | +| | `DELETE` | | Delete linked objects for a user, relationshipName can be ONLY a primary relationship name | +| | `EXEC` | | | diff --git a/docs/okta-docs/providers/okta/user/roles/index.md b/docs/okta-docs/providers/okta/user/roles/index.md index fb4afefd18..a430d5129b 100644 --- a/docs/okta-docs/providers/okta/user/roles/index.md +++ b/docs/okta-docs/providers/okta/user/roles/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroles
TypeResource
Idokta.user.roles
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `description` | `string` | -| `assignmentType` | `string` | -| `lastUpdated` | `string` | -| `status` | `string` | -| `_embedded` | `object` | -| `label` | `string` | -| `type` | `string` | -| `created` | `string` | -| `_links` | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `roleId, userId, subdomain` | Gets role that is assigne to user. | -| `list` | `SELECT` | `userId, subdomain` | Lists all roles assigned to a user. | -| `insert` | `INSERT` | `userId, subdomain` | Assigns a role to a user. | -| `delete` | `DELETE` | `roleId, userId, subdomain` | Unassigns a role from a user. | +| | `SELECT` | | Gets role that is assigne to user. | +| | `SELECT` | | Lists all roles assigned to a user. | +| | `INSERT` | | Assigns a role to a user. | +| | `DELETE` | | Unassigns a role from a user. | diff --git a/docs/okta-docs/providers/okta/user/sessions/index.md b/docs/okta-docs/providers/okta/user/sessions/index.md index d9691b8fa2..1e6a8be84a 100644 --- a/docs/okta-docs/providers/okta/user/sessions/index.md +++ b/docs/okta-docs/providers/okta/user/sessions/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesessions
TypeResource
Idokta.user.sessions
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/okta/stackql-okta-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `delete` | `DELETE` | `userId, subdomain` | +| | `DELETE` | | diff --git a/docs/okta-docs/providers/okta/user/users/index.md b/docs/okta-docs/providers/okta/user/users/index.md index 3879364b97..6d47fa0a59 100644 --- a/docs/okta-docs/providers/okta/user/users/index.md +++ b/docs/okta-docs/providers/okta/user/users/index.md @@ -14,51 +14,54 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idokta.user.users
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `transitioningToStatus` | `string` | -| `_links` | `object` | -| `profile` | `object` | -| `type` | `object` | -| `lastLogin` | `string` | -| `activated` | `string` | -| `passwordChanged` | `string` | -| `statusChanged` | `string` | -| `_embedded` | `object` | -| `credentials` | `object` | -| `status` | `string` | -| `created` | `string` | -| `lastUpdated` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `userId, subdomain` | Fetches a user from your Okta organization. | -| `list` | `SELECT` | `subdomain` | Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria. | -| `insert` | `INSERT` | `subdomain` | Creates a new user in your Okta organization with or without credentials. | -| `delete` | `DELETE` | `userId, subdomain` | Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!** | -| `activate` | `EXEC` | `sendEmail, userId, subdomain` | Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete. | -| `changePassword` | `EXEC` | `userId, subdomain` | Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential | -| `changeRecoveryQuestion` | `EXEC` | `userId, subdomain` | Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential | -| `deactivate` | `EXEC` | `userId, subdomain` | Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. Deactivation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `DEPROVISIONED` during deactivation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `DEPROVISIONED` when the deactivation process is complete. | -| `expirePassword` | `EXEC` | `userId, subdomain` | This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login. | -| `expirePasswordTemp` | `EXEC` | `userId, subdomain` | This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned. | -| `forgotPassword` | `EXEC` | `userId, subdomain` | | -| `reactivate` | `EXEC` | `userId, subdomain` | Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user). | -| `resetFactors` | `EXEC` | `userId, subdomain` | This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors. | -| `resetPassword` | `EXEC` | `sendEmail, userId, subdomain` | Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow. | -| `suspend` | `EXEC` | `userId, subdomain` | Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete. | -| `unlock` | `EXEC` | `userId, subdomain` | Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password. | -| `unsuspend` | `EXEC` | `userId, subdomain` | Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status. | -| `update` | `EXEC` | `userId, subdomain` | Update a user's profile and/or credentials using strict-update semantics. | +| | `SELECT` | | Fetches a user from your Okta organization. | +| | `SELECT` | | Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria. | +| | `INSERT` | | Creates a new user in your Okta organization with or without credentials. | +| | `DELETE` | | Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!** | +| | `EXEC` | | Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete. | +| | `EXEC` | | Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential | +| | `EXEC` | | Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential | +| | `EXEC` | | Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. Deactivation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `DEPROVISIONED` during deactivation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `DEPROVISIONED` when the deactivation process is complete. | +| | `EXEC` | | This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login. | +| | `EXEC` | | This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned. | +| | `EXEC` | | | +| | `EXEC` | | Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user). | +| | `EXEC` | | This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors. | +| | `EXEC` | | Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow. | +| | `EXEC` | | Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete. | +| | `EXEC` | | Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password. | +| | `EXEC` | | Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status. | +| | `EXEC` | | Update a user's profile and/or credentials using strict-update semantics. | diff --git a/docs/okta-docs/providers/okta/userfactor/catalog/index.md b/docs/okta-docs/providers/okta/userfactor/catalog/index.md index 472202a3ed..e0e8f4ebf6 100644 --- a/docs/okta-docs/providers/okta/userfactor/catalog/index.md +++ b/docs/okta-docs/providers/okta/userfactor/catalog/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecatalog
TypeResource
Idokta.userfactor.catalog
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `lastUpdated` | `string` | -| `created` | `string` | -| `verify` | `object` | -| `status` | `string` | -| `_links` | `object` | -| `factorType` | `string` | -| `provider` | `string` | -| `_embedded` | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/userfactor/factors/index.md b/docs/okta-docs/providers/okta/userfactor/factors/index.md index 75f678138e..b52a146252 100644 --- a/docs/okta-docs/providers/okta/userfactor/factors/index.md +++ b/docs/okta-docs/providers/okta/userfactor/factors/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefactors
TypeResource
Idokta.userfactor.factors
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `created` | `string` | -| `status` | `string` | -| `factorType` | `string` | -| `verify` | `object` | -| `_embedded` | `object` | -| `_links` | `object` | -| `lastUpdated` | `string` | -| `provider` | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `factorId, userId, subdomain` | Fetches a factor for the specified user | -| `list` | `SELECT` | `userId, subdomain` | Enumerates all the enrolled factors for the specified user | -| `insert` | `INSERT` | `userId, subdomain` | Enrolls a user with a supported factor. | -| `delete` | `DELETE` | `factorId, userId, subdomain` | Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor. | -| `activate` | `EXEC` | `factorId, userId, subdomain` | The `sms` and `token:software:totp` factor types require activation to complete the enrollment process. | -| `verify` | `EXEC` | `factorId, userId, subdomain` | Verifies an OTP for a `token` or `token:hardware` factor | +| | `SELECT` | | Fetches a factor for the specified user | +| | `SELECT` | | Enumerates all the enrolled factors for the specified user | +| | `INSERT` | | Enrolls a user with a supported factor. | +| | `DELETE` | | Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor. | +| | `EXEC` | | The `sms` and `token:software:totp` factor types require activation to complete the enrollment process. | +| | `EXEC` | | Verifies an OTP for a `token` or `token:hardware` factor | diff --git a/docs/okta-docs/providers/okta/userfactor/index.md b/docs/okta-docs/providers/okta/userfactor/index.md index 9d2fdcc5e7..47ac28e315 100644 --- a/docs/okta-docs/providers/okta/userfactor/index.md +++ b/docs/okta-docs/providers/okta/userfactor/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta user factor management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/userfactor/questions/index.md b/docs/okta-docs/providers/okta/userfactor/questions/index.md index db3fc40021..ccdd1e910b 100644 --- a/docs/okta-docs/providers/okta/userfactor/questions/index.md +++ b/docs/okta-docs/providers/okta/userfactor/questions/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namequestions
TypeResource
Idokta.userfactor.questions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `question` | `string` | -| `questionText` | `string` | -| `answer` | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list` | `SELECT` | `userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/userfactor/transactions/index.md b/docs/okta-docs/providers/okta/userfactor/transactions/index.md index 17e4674336..caddb4c2ce 100644 --- a/docs/okta-docs/providers/okta/userfactor/transactions/index.md +++ b/docs/okta-docs/providers/okta/userfactor/transactions/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametransactions
TypeResource
Idokta.userfactor.transactions
Id
## Fields | Name | Datatype | |:-----|:---------| -| `factorResult` | `string` | -| `factorResultMessage` | `string` | -| `_embedded` | `object` | -| `_links` | `object` | -| `expiresAt` | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `factorId, transactionId, userId, subdomain` | +| | `SELECT` | | diff --git a/docs/okta-docs/providers/okta/userschema/default/index.md b/docs/okta-docs/providers/okta/userschema/default/index.md index 6c5b31b167..dc4cf11b5e 100644 --- a/docs/okta-docs/providers/okta/userschema/default/index.md +++ b/docs/okta-docs/providers/okta/userschema/default/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedefault
TypeResource
Idokta.userschema.default
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `type` | `string` | -| `title` | `string` | -| `definitions` | `object` | -| `created` | `string` | -| `lastUpdated` | `string` | -| `properties` | `object` | -| `$schema` | `string` | -| `_links` | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `appInstanceId, subdomain` | Fetches the Schema for an App User | -| `insert` | `INSERT` | `appInstanceId, subdomain` | Partial updates on the User Profile properties of the Application User Schema. | +| | `SELECT` | | Fetches the Schema for an App User | +| | `INSERT` | | Partial updates on the User Profile properties of the Application User Schema. | diff --git a/docs/okta-docs/providers/okta/userschema/index.md b/docs/okta-docs/providers/okta/userschema/index.md index 5271a3ffd8..b1dd758bc7 100644 --- a/docs/okta-docs/providers/okta/userschema/index.md +++ b/docs/okta-docs/providers/okta/userschema/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta user schema management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/userschema/schemas/index.md b/docs/okta-docs/providers/okta/userschema/schemas/index.md index a457cbfa62..c7e7b88e7d 100644 --- a/docs/okta-docs/providers/okta/userschema/schemas/index.md +++ b/docs/okta-docs/providers/okta/userschema/schemas/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameschemas
TypeResource
Idokta.userschema.schemas
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `created` | `string` | -| `$schema` | `string` | -| `type` | `string` | -| `lastUpdated` | `string` | -| `properties` | `object` | -| `title` | `string` | -| `definitions` | `object` | -| `_links` | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `schemaId, subdomain` | Fetches the schema for a Schema Id. | -| `partialUpdate` | `EXEC` | `schemaId, subdomain` | Partial updates on the User Profile properties of the user schema. | +| | `SELECT` | | Fetches the schema for a Schema Id. | +| | `EXEC` | | Partial updates on the User Profile properties of the user schema. | diff --git a/docs/okta-docs/providers/okta/usertype/index.md b/docs/okta-docs/providers/okta/usertype/index.md index 11422e2790..48c98f65da 100644 --- a/docs/okta-docs/providers/okta/usertype/index.md +++ b/docs/okta-docs/providers/okta/usertype/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- + Okta user type management. :::info Service Summary diff --git a/docs/okta-docs/providers/okta/usertype/user/index.md b/docs/okta-docs/providers/okta/usertype/user/index.md index 14b8d9d317..e105b162bc 100644 --- a/docs/okta-docs/providers/okta/usertype/user/index.md +++ b/docs/okta-docs/providers/okta/usertype/user/index.md @@ -14,35 +14,38 @@ description: Query, deploy and manage Okta resources using SQL custom_edit_url: null image: /img/providers/okta/stackql-okta-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser
TypeResource
Idokta.usertype.user
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `description` | `string` | -| `_links` | `object` | -| `default` | `boolean` | -| `lastUpdatedBy` | `string` | -| `createdBy` | `string` | -| `displayName` | `string` | -| `lastUpdated` | `string` | -| `created` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `typeId, subdomain` | Fetches a User Type by ID. The special identifier `default` may be used to fetch the default User Type. | -| `list` | `SELECT` | `subdomain` | Fetches all User Types in your org | -| `insert` | `INSERT` | `subdomain` | Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10. | -| `delete` | `DELETE` | `typeId, subdomain` | Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users | -| `partialUpdate` | `EXEC` | `typeId, subdomain` | Updates an existing User Type | -| `update` | `EXEC` | `typeId, subdomain` | Replace an existing User Type | +| | `SELECT` | | Fetches a User Type by ID. The special identifier `default` may be used to fetch the default User Type. | +| | `SELECT` | | Fetches all User Types in your org | +| | `INSERT` | | Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10. | +| | `DELETE` | | Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users | +| | `EXEC` | | Updates an existing User Type | +| | `EXEC` | | Replace an existing User Type | diff --git a/docs/sumologic-docs/index.md b/docs/sumologic-docs/index.md index 2f61a41b9f..674a41c38b 100644 --- a/docs/sumologic-docs/index.md +++ b/docs/sumologic-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png id: sumologic-doc slug: /providers/sumologic - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Cloud-native, real-time, unified logs and metrics analytics platform. :::info Provider Summary (v23.04.00143) @@ -49,8 +51,8 @@ REGISTRY PULL sumologic; The following system environment variables are used for authentication by default: -- `SUMOLOGIC_ACCESSID` - SumoLogic Access ID (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) -- `SUMOLOGIC_ACCESSKEY` - SumoLogic Access Key (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) +- - SumoLogic Access ID (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) +- - SumoLogic Access Key (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -124,4 +126,4 @@ This parameter would be supplied to the `WHERE` clause of each `SELECT` statemen transformation_rules
users
- \ No newline at end of file + diff --git a/docs/sumologic-docs/providers/sumologic/access_keys/access_keys/index.md b/docs/sumologic-docs/providers/sumologic/access_keys/access_keys/index.md index 7ef924e1f5..ec67e99810 100644 --- a/docs/sumologic-docs/providers/sumologic/access_keys/access_keys/index.md +++ b/docs/sumologic-docs/providers/sumologic/access_keys/access_keys/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccess_keys
TypeResource
Idsumologic.access_keys.access_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the access key. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `createdBy` | `string` | Identifier of the user who created the access key. | -| `disabled` | `boolean` | Indicates whether the access key is disabled or not. | -| `label` | `string` | The name of the access key. | -| `lastUsed` | `string` | Last used timestamp in UTC. <br> **Note:** Property not in use, it is part of an upcoming feature. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `corsHeaders` | `array` | An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | +| | `string` | Identifier of the access key. | +| | `array` | An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the access key. | +| | `boolean` | Indicates whether the access key is disabled or not. | +| | `string` | The name of the access key. | +| | `string` | Last used timestamp in UTC. <br> **Note:** Property not in use, it is part of an upcoming feature. | +| | `string` | Last modification timestamp in UTC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `listAccessKeys` | `SELECT` | `region` | List all access keys in your account. | -| `createAccessKey` | `INSERT` | `data__label, region` | Creates a new access ID and key pair. The new access key can be used from the domains specified in corsHeaders field. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | -| `deleteAccessKey` | `DELETE` | `id, region` | Deletes the access key with the given accessId. | -| `updateAccessKey` | `EXEC` | `id, data__disabled, region` | Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list. | +| | `SELECT` | | List all access keys in your account. | +| | `INSERT` | | Creates a new access ID and key pair. The new access key can be used from the domains specified in corsHeaders field. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | +| | `DELETE` | | Deletes the access key with the given accessId. | +| | `EXEC` | | Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list. | diff --git a/docs/sumologic-docs/providers/sumologic/access_keys/index.md b/docs/sumologic-docs/providers/sumologic/access_keys/index.md index 187b45e8e6..c23182b6e0 100644 --- a/docs/sumologic-docs/providers/sumologic/access_keys/index.md +++ b/docs/sumologic-docs/providers/sumologic/access_keys/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + AccessKeys :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/access_keys/personal/index.md b/docs/sumologic-docs/providers/sumologic/access_keys/personal/index.md index 6cbd334ce1..c1aa79e40c 100644 --- a/docs/sumologic-docs/providers/sumologic/access_keys/personal/index.md +++ b/docs/sumologic-docs/providers/sumologic/access_keys/personal/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepersonal
TypeResource
Idsumologic.access_keys.personal
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the access key. | -| `createdBy` | `string` | Identifier of the user who created the access key. | -| `disabled` | `boolean` | Indicates whether the access key is disabled or not. | -| `label` | `string` | The name of the access key. | -| `lastUsed` | `string` | Last used timestamp in UTC. <br> **Note:** Property not in use, it is part of an upcoming feature. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `corsHeaders` | `array` | An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the access key. | +| | `array` | An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:
1. Requests with an ORIGIN header but the allowlist is empty.
2. Requests with an ORIGIN header that don't match any entry in the allowlist. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the access key. | +| | `boolean` | Indicates whether the access key is disabled or not. | +| | `string` | The name of the access key. | +| | `string` | Last used timestamp in UTC. <br> **Note:** Property not in use, it is part of an upcoming feature. | +| | `string` | Last modification timestamp in UTC. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listPersonalAccessKeys` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/account/account_owner/index.md b/docs/sumologic-docs/providers/sumologic/account/account_owner/index.md index 4085cdabef..a1bb16f99e 100644 --- a/docs/sumologic-docs/providers/sumologic/account/account_owner/index.md +++ b/docs/sumologic-docs/providers/sumologic/account/account_owner/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccount_owner
TypeResource
Idsumologic.account.account_owner
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAccountOwner` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/account/index.md b/docs/sumologic-docs/providers/sumologic/account/index.md index 28f34b24e0..fae80356cf 100644 --- a/docs/sumologic-docs/providers/sumologic/account/index.md +++ b/docs/sumologic-docs/providers/sumologic/account/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + account :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/account/status/index.md b/docs/sumologic-docs/providers/sumologic/account/status/index.md index 5f995a7f41..0046f2a825 100644 --- a/docs/sumologic-docs/providers/sumologic/account/status/index.md +++ b/docs/sumologic-docs/providers/sumologic/account/status/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus
TypeResource
Idsumologic.account.status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `accountActivated` | `boolean` | If the account is activated or not | -| `applicationUse` | `string` | The current usage of the application. | -| `canUpdatePlan` | `boolean` | If the plan can be updated by the given user | -| `planExpirationDays` | `integer` | The number of days in which the plan will expire | -| `planType` | `string` | Whether the account is `Free`/`Trial`/`Paid` | -| `pricingModel` | `string` | Whether the account is `cloudflex` or `credits` | +| | `boolean` | If the account is activated or not | +| | `string` | The current usage of the application. | +| | `boolean` | If the plan can be updated by the given user | +| | `integer` | The number of days in which the plan will expire | +| | `string` | Whether the account is `Free`/`Trial`/`Paid` | +| | `string` | Whether the account is `cloudflex` or `credits` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getStatus` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/account/subdomain/index.md b/docs/sumologic-docs/providers/sumologic/account/subdomain/index.md index 9902625467..089adb51b5 100644 --- a/docs/sumologic-docs/providers/sumologic/account/subdomain/index.md +++ b/docs/sumologic-docs/providers/sumologic/account/subdomain/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubdomain
TypeResource
Idsumologic.account.subdomain
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `url` | `string` | Login URL corresponding to the subdomain. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
| -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `subdomain` | `string` | The new subdomain. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
| +| | `string` | Identifier of the user who created the resource. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | The new subdomain. | +| | `string` | Login URL corresponding to the subdomain. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSubdomain` | `SELECT` | `region` | Get the configured subdomain. | -| `createSubdomain` | `INSERT` | `data__subdomain, region` | Create a subdomain. Only the Account Owner can create a subdomain. | -| `deleteSubdomain` | `DELETE` | `region` | Delete the configured subdomain. | -| `updateSubdomain` | `EXEC` | `data__subdomain, region` | Update a subdomain. Only the Account Owner can update the subdomain. | +| | `SELECT` | | Get the configured subdomain. | +| | `INSERT` | | Create a subdomain. Only the Account Owner can create a subdomain. | +| | `DELETE` | | Delete the configured subdomain. | +| | `EXEC` | | Update a subdomain. Only the Account Owner can update the subdomain. | diff --git a/docs/sumologic-docs/providers/sumologic/account/subdomain_recover/index.md b/docs/sumologic-docs/providers/sumologic/account/subdomain_recover/index.md index 354fff2e5b..552863ddc6 100644 --- a/docs/sumologic-docs/providers/sumologic/account/subdomain_recover/index.md +++ b/docs/sumologic-docs/providers/sumologic/account/subdomain_recover/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubdomain_recover
TypeResource
Idsumologic.account.subdomain_recover
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `recoverSubdomains` | `EXEC` | `email, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/apps/apps/index.md b/docs/sumologic-docs/providers/sumologic/apps/apps/index.md index c6e7dbf20a..29775328fe 100644 --- a/docs/sumologic-docs/providers/sumologic/apps/apps/index.md +++ b/docs/sumologic-docs/providers/sumologic/apps/apps/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapps
TypeResource
Idsumologic.apps.apps
Id
## Fields | Name | Datatype | |:-----|:---------| -| `appDefinition` | `object` | -| `appManifest` | `object` | +| | `object` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getApp` | `SELECT` | `uuid, region` | Gets the app with the given universally unique identifier (UUID). | -| `listApps` | `SELECT` | `region` | Lists all available apps from the App Catalog. | +| | `SELECT` | | Gets the app with the given universally unique identifier (UUID). | +| | `SELECT` | | Lists all available apps from the App Catalog. | diff --git a/docs/sumologic-docs/providers/sumologic/apps/index.md b/docs/sumologic-docs/providers/sumologic/apps/index.md index aca55db7bf..a8ecb1ee9e 100644 --- a/docs/sumologic-docs/providers/sumologic/apps/index.md +++ b/docs/sumologic-docs/providers/sumologic/apps/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + apps :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/apps/install/index.md b/docs/sumologic-docs/providers/sumologic/apps/install/index.md index 53e8cab5e5..94ab773de4 100644 --- a/docs/sumologic-docs/providers/sumologic/apps/install/index.md +++ b/docs/sumologic-docs/providers/sumologic/apps/install/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinstall
TypeResource
Idsumologic.apps.install
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `installApp` | `EXEC` | `uuid, data__description, data__destinationFolderId, data__name, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/apps/install_status/index.md b/docs/sumologic-docs/providers/sumologic/apps/install_status/index.md index bdbb3a77f9..8c56fb8fc7 100644 --- a/docs/sumologic-docs/providers/sumologic/apps/install_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/apps/install_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinstall_status
TypeResource
Idsumologic.apps.install_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | -| `error` | `object` | | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncInstallStatus` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/archive/index.md b/docs/sumologic-docs/providers/sumologic/archive/index.md index 310c4f0e31..a68dbf4c39 100644 --- a/docs/sumologic-docs/providers/sumologic/archive/index.md +++ b/docs/sumologic-docs/providers/sumologic/archive/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + archive :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/archive/jobs/index.md b/docs/sumologic-docs/providers/sumologic/archive/jobs/index.md index 18962f0c91..26da12bac0 100644 --- a/docs/sumologic-docs/providers/sumologic/archive/jobs/index.md +++ b/docs/sumologic-docs/providers/sumologic/archive/jobs/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namejobs
TypeResource
Idsumologic.archive.jobs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the ingestion job. | -| `name` | `string` | The name of the ingestion job. | -| `endTime` | `string` | The ending timestamp of the ingestion job. | -| `totalObjectsIngested` | `integer` | The total number of objects ingested by the ingestion job. | -| `startTime` | `string` | The starting timestamp of the ingestion job. | -| `createdAt` | `string` | The creation timestamp in UTC of the ingestion job. | -| `status` | `string` | The status of the ingestion job, either `Pending`,`Scanning`,`Ingesting`,`Failed`, or `Succeeded`. | -| `totalBytesIngested` | `integer` | The total bytes ingested by the ingestion job. | -| `createdBy` | `string` | The identifier of the user who created the ingestion job. | -| `totalObjectsScanned` | `integer` | The total number of objects scanned by the ingestion job. | +| | `string` | The unique identifier of the ingestion job. | +| | `string` | The name of the ingestion job. | +| | `string` | The creation timestamp in UTC of the ingestion job. | +| | `string` | The identifier of the user who created the ingestion job. | +| | `string` | The ending timestamp of the ingestion job. | +| | `string` | The starting timestamp of the ingestion job. | +| | `string` | The status of the ingestion job, either `Pending`,`Scanning`,`Ingesting`,`Failed`, or `Succeeded`. | +| | `integer` | The total bytes ingested by the ingestion job. | +| | `integer` | The total number of objects ingested by the ingestion job. | +| | `integer` | The total number of objects scanned by the ingestion job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `listArchiveJobsBySourceId` | `SELECT` | `sourceId, region` | Get a list of all the ingestion jobs created on an Archive Source. The response is paginated with a default limit of 10 jobs per page. | -| `createArchiveJob` | `INSERT` | `sourceId, data__endTime, data__name, data__startTime, region` | Create an ingestion job to pull data from your S3 bucket. | -| `deleteArchiveJob` | `DELETE` | `id, sourceId, region` | Delete an ingestion job with the given identifier from the organization. The delete operation is only possible for jobs with a Succeeded or Failed status. | +| | `SELECT` | | Get a list of all the ingestion jobs created on an Archive Source. The response is paginated with a default limit of 10 jobs per page. | +| | `INSERT` | | Create an ingestion job to pull data from your S3 bucket. | +| | `DELETE` | | Delete an ingestion job with the given identifier from the organization. The delete operation is only possible for jobs with a Succeeded or Failed status. | diff --git a/docs/sumologic-docs/providers/sumologic/archive/jobs_count/index.md b/docs/sumologic-docs/providers/sumologic/archive/jobs_count/index.md index ecbdf7f979..a03f0e4330 100644 --- a/docs/sumologic-docs/providers/sumologic/archive/jobs_count/index.md +++ b/docs/sumologic-docs/providers/sumologic/archive/jobs_count/index.md @@ -14,26 +14,29 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namejobs_count
TypeResource
Idsumologic.archive.jobs_count
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `scanning` | `integer` | The total number of archive jobs with scanning status for the archive source. | -| `sourceId` | `string` | Identifier for the archive source. | -| `succeeded` | `integer` | The total number of archive jobs with succeeded status for the archive source. | -| `failed` | `integer` | The total number of archive jobs with failed status for the archive source. | -| `ingesting` | `integer` | The total number of archive jobs with ingesting status for the archive source. | -| `pending` | `integer` | The total number of archive jobs with pending status for the archive source. | +| | `integer` | The total number of archive jobs with failed status for the archive source. | +| | `integer` | The total number of archive jobs with ingesting status for the archive source. | +| | `integer` | The total number of archive jobs with pending status for the archive source. | +| | `integer` | The total number of archive jobs with scanning status for the archive source. | +| | `string` | Identifier for the archive source. | +| | `integer` | The total number of archive jobs with succeeded status for the archive source. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listArchiveJobsCountPerSource` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/collectors/collectors/index.md b/docs/sumologic-docs/providers/sumologic/collectors/collectors/index.md index 4608eae783..611005212a 100644 --- a/docs/sumologic-docs/providers/sumologic/collectors/collectors/index.md +++ b/docs/sumologic-docs/providers/sumologic/collectors/collectors/index.md @@ -14,46 +14,49 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecollectors
TypeResource
Idsumologic.collectors.collectors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | Identifier | -| `name` | `string` | Name of the Collector. It must be unique on your account. | -| `description` | `string` | Description of the Collector. | -| `cutoffRelativeTime` | `string` | Can be specified instead of cutoffTimestamp to provide a relative offset with respect to the current time. Example: use "-1h", "-1d", or "-1w" to collect data thats less than one hour, one day, or one week old, respectively. | -| `osVersion` | `string` | Version of the OS that Collector is installed on. [Installed Collectors only] | -| `ephemeral` | `boolean` | When true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral. | -| `targetCpu` | `integer` | When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. | -| `osArch` | `string` | Architecture of the OS that Collector is installed on. [Installed Collectors only] | -| `sourceSyncMode` | `string` | For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI) | -| `alive` | `boolean` | When a Collector is running it sends Sumo a heartbeat message every 15 seconds. If no heartbeat message is received after 30 minutes this becomes false. | -| `lastSeenAlive` | `integer` | The last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch. | -| `osTime` | `integer` | Time that the Collector has been running, in milliseconds. [Installed Collectors only] | -| `osName` | `string` | Name of OS that Collector is installed on. [Installed Collectors only] | -| `links` | `array` | | -| `timeZone` | `string` | Time zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article. | -| `fields` | `object` | JSON map of key-value fields (metadata) to apply to the Collector. | -| `category` | `string` | The Category of the Collector, used as metadata when searching data. | -| `collectorType` | `string` | The Collector type: Installable or Hosted | -| `collectorVersion` | `string` | Version of the Collector software installed. | -| `cutoffTimestamp` | `integer` | 0 (collects all data)\|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch | -| `hostName` | `string` | Host name of the Collector. The hostname can be a maximum of 128 characters. | +| | `integer` | Identifier | +| | `string` | Name of the Collector. It must be unique on your account. | +| | `string` | Description of the Collector. | +| | `boolean` | When a Collector is running it sends Sumo a heartbeat message every 15 seconds. If no heartbeat message is received after 30 minutes this becomes false. | +| | `string` | The Category of the Collector, used as metadata when searching data. | +| | `string` | The Collector type: Installable or Hosted | +| | `string` | Version of the Collector software installed. | +| | `string` | Can be specified instead of cutoffTimestamp to provide a relative offset with respect to the current time. Example: use "-1h", "-1d", or "-1w" to collect data thats less than one hour, one day, or one week old, respectively. | +| | `integer` | 0 (collects all data)\|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch | +| | `boolean` | When true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral. | +| | `object` | JSON map of key-value fields (metadata) to apply to the Collector. | +| | `string` | Host name of the Collector. The hostname can be a maximum of 128 characters. | +| | `integer` | The last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch. | +| | `array` | | +| | `string` | Architecture of the OS that Collector is installed on. [Installed Collectors only] | +| | `string` | Name of OS that Collector is installed on. [Installed Collectors only] | +| | `integer` | Time that the Collector has been running, in milliseconds. [Installed Collectors only] | +| | `string` | Version of the OS that Collector is installed on. [Installed Collectors only] | +| | `string` | For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI) | +| | `integer` | When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. | +| | `string` | Time zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_collector_by_name` | `SELECT` | `name, region` | Get the Collector with the specified name. | -| `list_collectors` | `SELECT` | `region` | Get a list of Collectors with an optional limit and offset. | -| `create_collector` | `INSERT` | `region` | Create Hosted Collector. This method can only be used to create Hosted Collectors. You must install a Collector manually to create an Installed Collector. | -| `delete_collector` | `DELETE` | `id, region` | Delete Collector by ID | -| `get_collector_by_id` | `EXEC` | `id, region` | Get the Collector with the specified Identifier. | -| `update_collector` | `EXEC` | `id, region` | Update a Collector | +| | `SELECT` | | Get the Collector with the specified name. | +| | `SELECT` | | Get a list of Collectors with an optional limit and offset. | +| | `INSERT` | | Create Hosted Collector. This method can only be used to create Hosted Collectors. You must install a Collector manually to create an Installed Collector. | +| | `DELETE` | | Delete Collector by ID | +| | `EXEC` | | Get the Collector with the specified Identifier. | +| | `EXEC` | | Update a Collector | diff --git a/docs/sumologic-docs/providers/sumologic/collectors/index.md b/docs/sumologic-docs/providers/sumologic/collectors/index.md index f91eb098f1..3f508c4075 100644 --- a/docs/sumologic-docs/providers/sumologic/collectors/index.md +++ b/docs/sumologic-docs/providers/sumologic/collectors/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + collectors :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/collectors/offline_collectors/index.md b/docs/sumologic-docs/providers/sumologic/collectors/offline_collectors/index.md index cc4ea30d9a..72093b49b9 100644 --- a/docs/sumologic-docs/providers/sumologic/collectors/offline_collectors/index.md +++ b/docs/sumologic-docs/providers/sumologic/collectors/offline_collectors/index.md @@ -14,41 +14,44 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoffline_collectors
TypeResource
Idsumologic.collectors.offline_collectors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | Identifier | -| `name` | `string` | Name of the Collector. It must be unique on your account. | -| `description` | `string` | Description of the Collector. | -| `collectorVersion` | `string` | Version of the Collector software installed. | -| `osVersion` | `string` | Version of the OS that Collector is installed on. [Installed Collectors only] | -| `osArch` | `string` | Architecture of the OS that Collector is installed on. [Installed Collectors only] | -| `ephemeral` | `boolean` | When true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral. | -| `fields` | `object` | JSON map of key-value fields (metadata) to apply to the Collector. | -| `targetCpu` | `integer` | When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. | -| `lastSeenAlive` | `integer` | The last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch. | -| `collectorType` | `string` | The Collector type: Installable or Hosted | -| `timeZone` | `string` | Time zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article. | -| `sourceSyncMode` | `string` | For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI) | -| `hostName` | `string` | Host name of the Collector. The hostname can be a maximum of 128 characters. | -| `category` | `string` | The Category of the Collector, used as metadata when searching data. | -| `osTime` | `integer` | Time that the Collector has been running, in milliseconds. [Installed Collectors only] | -| `links` | `array` | | -| `alive` | `boolean` | When a Collector is running it sends Sumo a heartbeat message every 15 seconds. If no heartbeat message is received after 30 minutes this becomes false. | -| `cutoffRelativeTime` | `string` | Can be specified instead of cutoffTimestamp to provide a relative offset with respect to the current time. Example: use "-1h", "-1d", or "-1w" to collect data thats less than one hour, one day, or one week old, respectively. | -| `osName` | `string` | Name of OS that Collector is installed on. [Installed Collectors only] | -| `cutoffTimestamp` | `integer` | 0 (collects all data)\|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch | +| | `integer` | Identifier | +| | `string` | Name of the Collector. It must be unique on your account. | +| | `string` | Description of the Collector. | +| | `boolean` | When a Collector is running it sends Sumo a heartbeat message every 15 seconds. If no heartbeat message is received after 30 minutes this becomes false. | +| | `string` | The Category of the Collector, used as metadata when searching data. | +| | `string` | The Collector type: Installable or Hosted | +| | `string` | Version of the Collector software installed. | +| | `string` | Can be specified instead of cutoffTimestamp to provide a relative offset with respect to the current time. Example: use "-1h", "-1d", or "-1w" to collect data thats less than one hour, one day, or one week old, respectively. | +| | `integer` | 0 (collects all data)\|Only collect data from files with a modified date more recent than this timestamp, specified as milliseconds since epoch | +| | `boolean` | When true, the collector will be deleted after 12 hours of inactivity. For more information, see Setting a Collector as Ephemeral. | +| | `object` | JSON map of key-value fields (metadata) to apply to the Collector. | +| | `string` | Host name of the Collector. The hostname can be a maximum of 128 characters. | +| | `integer` | The last time the Sumo Logic service received an active heartbeat from the Collector, specified as milliseconds since epoch. | +| | `array` | | +| | `string` | Architecture of the OS that Collector is installed on. [Installed Collectors only] | +| | `string` | Name of OS that Collector is installed on. [Installed Collectors only] | +| | `integer` | Time that the Collector has been running, in milliseconds. [Installed Collectors only] | +| | `string` | Version of the OS that Collector is installed on. [Installed Collectors only] | +| | `string` | For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI) | +| | `integer` | When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. | +| | `string` | Time zone of the Collector. For a list of possible values, refer to the "TZ" column in this Wikipedia article. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_offline_collectors` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/collectors/sources/index.md b/docs/sumologic-docs/providers/sumologic/collectors/sources/index.md index 9b90d74acd..601b5a3caa 100644 --- a/docs/sumologic-docs/providers/sumologic/collectors/sources/index.md +++ b/docs/sumologic-docs/providers/sumologic/collectors/sources/index.md @@ -14,43 +14,46 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesources
TypeResource
Idsumologic.collectors.sources
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `integer` | Source identifer. | -| `name` | `string` | Source name. | -| `multilineProcessingEnabled` | `boolean` | Source multilineProcessingEnabled. | -| `messagePerRequest` | `boolean` | Source messagePerRequest. | -| `automaticDateParsing` | `boolean` | Source automaticDateParsing. | -| `fields` | `object` | Source fields. | -| `pathExpression` | `string` | Source pathExpression. | -| `hostName` | `string` | Source hostName. | -| `cutoffTimestamp` | `integer` | Source cutoffTimestamp. | -| `denylist` | `array` | Source denylist. | -| `forceTimeZone` | `boolean` | Source forceTimeZone. | -| `encoding` | `string` | Source encoding. | -| `sourceType` | `string` | Source sourceType. | -| `url` | `string` | Source url. | -| `useAutolineMatching` | `boolean` | Source useAutolineMatching. | -| `filters` | `array` | Source filters. | -| `alive` | `boolean` | Source alive. | -| `category` | `string` | Source category. | -| `hashAlgorithm` | `string` | Source hashAlgorithm. | +| | `integer` | Source identifer. | +| | `string` | Source name. | +| | `boolean` | Source alive. | +| | `boolean` | Source automaticDateParsing. | +| | `string` | Source category. | +| | `integer` | Source cutoffTimestamp. | +| | `array` | Source denylist. | +| | `string` | Source encoding. | +| | `object` | Source fields. | +| | `array` | Source filters. | +| | `boolean` | Source forceTimeZone. | +| | `string` | Source hashAlgorithm. | +| | `string` | Source hostName. | +| | `boolean` | Source messagePerRequest. | +| | `boolean` | Source multilineProcessingEnabled. | +| | `string` | Source pathExpression. | +| | `string` | Source sourceType. | +| | `string` | Source url. | +| | `boolean` | Source useAutolineMatching. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_source_by_id` | `SELECT` | `collectorId, sourceId, region` | Gets information about a specified Collector and Source. | -| `list_sources` | `SELECT` | `collectorId, region` | Gets information about all Sources for a specified Collector. | -| `create_source` | `INSERT` | `collectorId, region` | Creates a new Source for a Collector. See Use JSON to Configure Sources for required fields for the request JSON file. | -| `delete_source` | `DELETE` | `collectorId, sourceId, region` | Delete Source by ID | -| `update_source` | `EXEC` | `collectorId, sourceId, region` | Update a source | +| | `SELECT` | | Gets information about a specified Collector and Source. | +| | `SELECT` | | Gets information about all Sources for a specified Collector. | +| | `INSERT` | | Creates a new Source for a Collector. See Use JSON to Configure Sources for required fields for the request JSON file. | +| | `DELETE` | | Delete Source by ID | +| | `EXEC` | | Update a source | diff --git a/docs/sumologic-docs/providers/sumologic/connections/connections/index.md b/docs/sumologic-docs/providers/sumologic/connections/connections/index.md index 491b42d2e5..219b63f746 100644 --- a/docs/sumologic-docs/providers/sumologic/connections/connections/index.md +++ b/docs/sumologic-docs/providers/sumologic/connections/connections/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconnections
TypeResource
Idsumologic.connections.connections
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the connection. | -| `name` | `string` | Name of the connection. | -| `description` | `string` | Description of the connection. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `type` | `string` | Type of connection. Valid values are `WebhookConnection`, `ServiceNowConnection`. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Unique identifier for the connection. | +| | `string` | Name of the connection. | +| | `string` | Description of the connection. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Type of connection. Valid values are `WebhookConnection`, `ServiceNowConnection`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getConnection` | `SELECT` | `id, type, region` | Get a connection with the given identifier. | -| `listConnections` | `SELECT` | `region` | Get a list of all connections in the organization. The response is paginated with a default limit of 100 connections per page. | -| `createConnection` | `INSERT` | `data__name, data__type, region` | Create a new connection in the organization. | -| `deleteConnection` | `DELETE` | `id, type, region` | Delete a connection with the given identifier. | -| `updateConnection` | `EXEC` | `id, data__name, data__type, region` | Update an existing connection. | +| | `SELECT` | | Get a connection with the given identifier. | +| | `SELECT` | | Get a list of all connections in the organization. The response is paginated with a default limit of 100 connections per page. | +| | `INSERT` | | Create a new connection in the organization. | +| | `DELETE` | | Delete a connection with the given identifier. | +| | `EXEC` | | Update an existing connection. | diff --git a/docs/sumologic-docs/providers/sumologic/connections/incident_templates/index.md b/docs/sumologic-docs/providers/sumologic/connections/incident_templates/index.md index 49d4e329e7..f10dfcb953 100644 --- a/docs/sumologic-docs/providers/sumologic/connections/incident_templates/index.md +++ b/docs/sumologic-docs/providers/sumologic/connections/incident_templates/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_templates
TypeResource
Idsumologic.connections.incident_templates
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getIncidentTemplates` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/connections/index.md b/docs/sumologic-docs/providers/sumologic/connections/index.md index 9eb57799c8..38be3b4821 100644 --- a/docs/sumologic-docs/providers/sumologic/connections/index.md +++ b/docs/sumologic-docs/providers/sumologic/connections/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + connections :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/connections/test/index.md b/docs/sumologic-docs/providers/sumologic/connections/test/index.md index 4a11601e53..9d431a022e 100644 --- a/docs/sumologic-docs/providers/sumologic/connections/test/index.md +++ b/docs/sumologic-docs/providers/sumologic/connections/test/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametest
TypeResource
Idsumologic.connections.test
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `testConnection` | `EXEC` | `data__name, data__type, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/copy/index.md b/docs/sumologic-docs/providers/sumologic/content/copy/index.md index e193b37787..89fcd82aae 100644 --- a/docs/sumologic-docs/providers/sumologic/content/copy/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/copy/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecopy
TypeResource
Idsumologic.content.copy
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `beginAsyncCopy` | `EXEC` | `destinationFolder, id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/copy_status/index.md b/docs/sumologic-docs/providers/sumologic/content/copy_status/index.md index f8adc952c1..2994802185 100644 --- a/docs/sumologic-docs/providers/sumologic/content/copy_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/copy_status/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecopy_status
TypeResource
Idsumologic.content.copy_status
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `asyncCopyStatus` | `EXEC` | `id, jobId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/delete/index.md b/docs/sumologic-docs/providers/sumologic/content/delete/index.md index e2b760839d..c0b737cc84 100644 --- a/docs/sumologic-docs/providers/sumologic/content/delete/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/delete/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedelete
TypeResource
Idsumologic.content.delete
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `beginAsyncDelete` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/delete_status/index.md b/docs/sumologic-docs/providers/sumologic/content/delete_status/index.md index 3726ea2386..cb02308374 100644 --- a/docs/sumologic-docs/providers/sumologic/content/delete_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/delete_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedelete_status
TypeResource
Idsumologic.content.delete_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `object` | | -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncDeleteStatus` | `SELECT` | `id, jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/export/index.md b/docs/sumologic-docs/providers/sumologic/content/export/index.md index 67695faab3..8dbdfe8010 100644 --- a/docs/sumologic-docs/providers/sumologic/content/export/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/export/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameexport
TypeResource
Idsumologic.content.export
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `beginAsyncExport` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/export_result/index.md b/docs/sumologic-docs/providers/sumologic/content/export_result/index.md index 22d503dca8..402eca3953 100644 --- a/docs/sumologic-docs/providers/sumologic/content/export_result/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/export_result/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameexport_result
TypeResource
Idsumologic.content.export_result
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the item. | -| `type` | `string` | The content item type.
**Note:**
- `MewboardSyncDefinition` _is depreciated, and will soon be removed. Please use_ `DashboardV2SyncDefinition`
_instead_.
- Dashboard links are not supported for dashboards. | +| | `string` | The name of the item. | +| | `string` | The content item type.
**Note:**
- `MewboardSyncDefinition` _is depreciated, and will soon be removed. Please use_ `DashboardV2SyncDefinition`
_instead_.
- Dashboard links are not supported for dashboards. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncExportResult` | `SELECT` | `contentId, jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/export_status/index.md b/docs/sumologic-docs/providers/sumologic/content/export_status/index.md index c409e27793..b55a9cd551 100644 --- a/docs/sumologic-docs/providers/sumologic/content/export_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/export_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameexport_status
TypeResource
Idsumologic.content.export_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `object` | | -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncExportStatus` | `SELECT` | `contentId, jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders/index.md b/docs/sumologic-docs/providers/sumologic/content/folders/index.md index b86a704918..af6528c014 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders
TypeResource
Idsumologic.content.folders
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the content item. | -| `name` | `string` | The name of the content item. | -| `description` | `string` | The description of the folder. | -| `itemType` | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `parentId` | `string` | Identifier of the parent content item. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `permissions` | `array` | List of permissions the user has on the content item. | -| `children` | `array` | A list of the content items. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the content item. | +| | `string` | The name of the content item. | +| | `string` | The description of the folder. | +| | `array` | A list of the content items. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent content item. | +| | `array` | List of permissions the user has on the content item. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getFolder` | `SELECT` | `id, region` | Get a folder with the given identifier. Set the header parameter `isAdminMode` to `"true"` if fetching a folder inside "Admin Recommended" folder. | -| `createFolder` | `INSERT` | `data__name, data__parentId, region` | Creates a new folder under the given parent folder. Set the header parameter `isAdminMode` to `"true"` to create a folder inside "Admin Recommended" folder. | -| `updateFolder` | `EXEC` | `id, data__name, region` | Update an existing folder with the given identifier. Set the header parameter `isAdminMode` to `"true"` if updating a folder inside "Admin Recommended" folder. | +| | `SELECT` | | Get a folder with the given identifier. Set the header parameter `isAdminMode` to `"true"` if fetching a folder inside "Admin Recommended" folder. | +| | `INSERT` | | Creates a new folder under the given parent folder. Set the header parameter `isAdminMode` to `"true"` to create a folder inside "Admin Recommended" folder. | +| | `EXEC` | | Update an existing folder with the given identifier. Set the header parameter `isAdminMode` to `"true"` if updating a folder inside "Admin Recommended" folder. | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended/index.md index 5cef974402..1e98f64e2a 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_admin_recommended
TypeResource
Idsumologic.content.folders_admin_recommended
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAdminRecommendedFolderAsync` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_result/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_result/index.md index 5ba0d82934..b832191f61 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_result/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_result/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_admin_recommended_result
TypeResource
Idsumologic.content.folders_admin_recommended_result
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the content item. | -| `name` | `string` | The name of the content item. | -| `description` | `string` | The description of the folder. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `permissions` | `array` | List of permissions the user has on the content item. | -| `children` | `array` | A list of the content items. | -| `parentId` | `string` | Identifier of the parent content item. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `itemType` | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | +| | `string` | Identifier of the content item. | +| | `string` | The name of the content item. | +| | `string` | The description of the folder. | +| | `array` | A list of the content items. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent content item. | +| | `array` | List of permissions the user has on the content item. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAdminRecommendedFolderAsyncResult` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_status/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_status/index.md index 2efa28ff22..7c13f7b17b 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_admin_recommended_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_admin_recommended_status
TypeResource
Idsumologic.content.folders_admin_recommended_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `object` | | -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAdminRecommendedFolderAsyncStatus` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_global/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_global/index.md index 7f97ea3c28..10dcf73dcf 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_global/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_global/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_global
TypeResource
Idsumologic.content.folders_global
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getGlobalFolderAsync` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_global_result/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_global_result/index.md index c20b31155f..34df51c592 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_global_result/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_global_result/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_global_result
TypeResource
Idsumologic.content.folders_global_result
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the content item. | -| `name` | `string` | The name of the content item. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `parentId` | `string` | Identifier of the parent content item. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `itemType` | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | -| `permissions` | `array` | List of permissions the user has on the content item. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the content item. | +| | `string` | The name of the content item. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent content item. | +| | `array` | List of permissions the user has on the content item. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getGlobalFolderAsyncResult` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_global_status/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_global_status/index.md index b084008431..efcce6d1b2 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_global_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_global_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_global_status
TypeResource
Idsumologic.content.folders_global_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | -| `error` | `object` | | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getGlobalFolderAsyncStatus` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_import/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_import/index.md index 214f3b19e6..b6233b7c01 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_import/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_import/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_import
TypeResource
Idsumologic.content.folders_import
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `beginAsyncImport` | `EXEC` | `folderId, data__name, data__type, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_import_status/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_import_status/index.md index b7e6ec282f..683336f267 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_import_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_import_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_import_status
TypeResource
Idsumologic.content.folders_import_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `object` | | -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncImportStatus` | `SELECT` | `folderId, jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/folders_personal/index.md b/docs/sumologic-docs/providers/sumologic/content/folders_personal/index.md index f1994e5df4..530b094750 100644 --- a/docs/sumologic-docs/providers/sumologic/content/folders_personal/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/folders_personal/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefolders_personal
TypeResource
Idsumologic.content.folders_personal
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the content item. | -| `name` | `string` | The name of the content item. | -| `description` | `string` | The description of the folder. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `children` | `array` | A list of the content items. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `itemType` | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | -| `permissions` | `array` | List of permissions the user has on the content item. | -| `parentId` | `string` | Identifier of the parent content item. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the content item. | +| | `string` | The name of the content item. | +| | `string` | The description of the folder. | +| | `array` | A list of the content items. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Type of the content item. Supported values are:
1. Folder
2. Search
3. Report (for old dashboards)
4. Dashboard (for new dashboards)
5. Lookups | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent content item. | +| | `array` | List of permissions the user has on the content item. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getPersonalFolder` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/index.md b/docs/sumologic-docs/providers/sumologic/content/index.md index b714fce8bc..1438a5bdcc 100644 --- a/docs/sumologic-docs/providers/sumologic/content/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + content :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/content/move/index.md b/docs/sumologic-docs/providers/sumologic/content/move/index.md index da22e38438..a9c3f5c437 100644 --- a/docs/sumologic-docs/providers/sumologic/content/move/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/move/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemove
TypeResource
Idsumologic.content.move
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `moveItem` | `EXEC` | `destinationFolderId, id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/path/index.md b/docs/sumologic-docs/providers/sumologic/content/path/index.md index 20f77f7a88..6e83d2e3d4 100644 --- a/docs/sumologic-docs/providers/sumologic/content/path/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/path/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepath
TypeResource
Idsumologic.content.path
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getItemByPath` | `SELECT` | `path, region` | Get a content item corresponding to the given path.

_Path is specified in the required query parameter `path`. The path should be URL encoded._ For example, to get "Acme Corp" folder of a user "user@sumo.com" you can use the following curl command:
```bash
curl https://api.sumologic.com/api/v2/content/path?path=/Library/Users/user%40sumo.com/Acme%20Corp
```


The absolute path to a content item should be specified to get the item. The content library has "Library" folder at the root level. For items in "Personal" folder, the base path is "/Library/Users/user@sumo.com" where "user@sumo.com" is the email address of the user. For example if a user with email address `wile@acme.com` has `Rockets` folder inside Personal folder, the path of Rockets folder will be `/Library/Users/wile@acme.com/Rockets`.

For items in "Admin Recommended" folder, the base path is "/Library/Admin Recommended". For example, given a folder `Acme` in Admin Recommended folder, the path will be `/Library/Admin Recommended/Acme`. | -| `getPathById` | `SELECT` | `contentId, region` | Get full path of a content item with the given identifier.
| +| | `SELECT` | | Get a content item corresponding to the given path.

_Path is specified in the required query parameter `path`. The path should be URL encoded._ For example, to get "Acme Corp" folder of a user "user@sumo.com" you can use the following curl command:
```bash
curl https://api.sumologic.com/api/v2/content/path?path=/Library/Users/user%40sumo.com/Acme%20Corp
```


The absolute path to a content item should be specified to get the item. The content library has "Library" folder at the root level. For items in "Personal" folder, the base path is "/Library/Users/user@sumo.com" where "user@sumo.com" is the email address of the user. For example if a user with email address `wile@acme.com` has `Rockets` folder inside Personal folder, the path of Rockets folder will be `/Library/Users/wile@acme.com/Rockets`.

For items in "Admin Recommended" folder, the base path is "/Library/Admin Recommended". For example, given a folder `Acme` in Admin Recommended folder, the path will be `/Library/Admin Recommended/Acme`. | +| | `SELECT` | | Get full path of a content item with the given identifier.
| diff --git a/docs/sumologic-docs/providers/sumologic/content/permissions/index.md b/docs/sumologic-docs/providers/sumologic/content/permissions/index.md index a395be0fe2..28a3298817 100644 --- a/docs/sumologic-docs/providers/sumologic/content/permissions/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/permissions/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions
TypeResource
Idsumologic.content.permissions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `explicitPermissions` | `array` | Explicitly assigned content permissions. | -| `implicitPermissions` | `array` | Implicitly inherited content permissions. | +| | `array` | Explicitly assigned content permissions. | +| | `array` | Implicitly inherited content permissions. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getContentPermissions` | `SELECT` | `id, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/permissions_add/index.md b/docs/sumologic-docs/providers/sumologic/content/permissions_add/index.md index 3c3538143a..5e06510243 100644 --- a/docs/sumologic-docs/providers/sumologic/content/permissions_add/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/permissions_add/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions_add
TypeResource
Idsumologic.content.permissions_add
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `addContentPermissions` | `EXEC` | `id, data__contentPermissionAssignments, data__notificationMessage, data__notifyRecipients, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/content/permissions_remove/index.md b/docs/sumologic-docs/providers/sumologic/content/permissions_remove/index.md index 784e1a65a5..c2818c4cbe 100644 --- a/docs/sumologic-docs/providers/sumologic/content/permissions_remove/index.md +++ b/docs/sumologic-docs/providers/sumologic/content/permissions_remove/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions_remove
TypeResource
Idsumologic.content.permissions_remove
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `removeContentPermissions` | `EXEC` | `id, data__contentPermissionAssignments, data__notificationMessage, data__notifyRecipients, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/dashboards/dashboards/index.md b/docs/sumologic-docs/providers/sumologic/dashboards/dashboards/index.md index d13a7090df..521753e347 100644 --- a/docs/sumologic-docs/providers/sumologic/dashboards/dashboards/index.md +++ b/docs/sumologic-docs/providers/sumologic/dashboards/dashboards/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedashboards
TypeResource
Idsumologic.dashboards.dashboards
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the dashboard. This id is used to get detailed information about the dashboard, such as panels, variables and the layout.
| -| `description` | `string` | Description of the dashboard. | -| `panels` | `array` | Panels in the dashboard. | -| `topologyLabelMap` | `object` | Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key.
| -| `title` | `string` | Title of the dashboard. | -| `scheduleId` | `string` | Scheduled report identifier for the dashboard. Only most recently modified report schedule is rerun per dashboard. This id is used to manage the schedule details through the scheduled report API.
| -| `domain` | `string` | If set denotes that the dashboard concerns a given domain (e.g. `aws`, `k8s`, `app`). | -| `variables` | `array` | Variables to apply to the panels. | -| `layout` | `object` | | -| `hierarchies` | `array` | If set to non-empty array denotes that the dashboard concerns given hierarchies. | -| `theme` | `string` | Theme for the dashboard. Either `Light` or `Dark`. | -| `folderId` | `string` | The identifier of the folder to save the dashboard in. By default it is saved in your personal folder.
| -| `refreshInterval` | `integer` | Interval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are `0`, `30`, `60`, 120`, `300`, `900`, `3600`, `86400`.
| -| `contentId` | `string` | Content identifier for the dashboard. This id is used to connect to the Sumo Content Library and get general metadata about the dashboard. Use this id if you want to search for dashboards in Sumo folders.
| -| `timeRange` | `object` | | +| | `string` | Unique identifier for the dashboard. This id is used to get detailed information about the dashboard, such as panels, variables and the layout.
| +| | `string` | Description of the dashboard. | +| | `string` | Content identifier for the dashboard. This id is used to connect to the Sumo Content Library and get general metadata about the dashboard. Use this id if you want to search for dashboards in Sumo folders.
| +| | `string` | If set denotes that the dashboard concerns a given domain (e.g. `aws`, `k8s`, `app`). | +| | `string` | The identifier of the folder to save the dashboard in. By default it is saved in your personal folder.
| +| | `array` | If set to non-empty array denotes that the dashboard concerns given hierarchies. | +| | `object` | | +| | `array` | Panels in the dashboard. | +| | `integer` | Interval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are `0`, `30`, `60`, 120`, `300`, `900`, `3600`, `86400`.
| +| | `string` | Scheduled report identifier for the dashboard. Only most recently modified report schedule is rerun per dashboard. This id is used to manage the schedule details through the scheduled report API.
| +| | `string` | Theme for the dashboard. Either `Light` or `Dark`. | +| | `object` | | +| | `string` | Title of the dashboard. | +| | `object` | Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key.
| +| | `array` | Variables to apply to the panels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDashboard` | `SELECT` | `id, region` | Get a dashboard by the given identifier. | -| `listDashboards` | `SELECT` | `region` | List all dashboards under the Personal folder created by the user or under folders viewable by user. | -| `createDashboard` | `INSERT` | `data__timeRange, data__title, region` | Creates a new dashboard. | -| `deleteDashboard` | `DELETE` | `id, region` | Delete a dashboard by the given identifier. | -| `updateDashboard` | `EXEC` | `id, data__timeRange, data__title, region` | Update a dashboard by the given identifier. | +| | `SELECT` | | Get a dashboard by the given identifier. | +| | `SELECT` | | List all dashboards under the Personal folder created by the user or under folders viewable by user. | +| | `INSERT` | | Creates a new dashboard. | +| | `DELETE` | | Delete a dashboard by the given identifier. | +| | `EXEC` | | Update a dashboard by the given identifier. | diff --git a/docs/sumologic-docs/providers/sumologic/dashboards/index.md b/docs/sumologic-docs/providers/sumologic/dashboards/index.md index 73ef3a22d6..a7fa79e775 100644 --- a/docs/sumologic-docs/providers/sumologic/dashboards/index.md +++ b/docs/sumologic-docs/providers/sumologic/dashboards/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + dashboards :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs/index.md b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs/index.md index 1b695f09d4..135a8ae266 100644 --- a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs/index.md +++ b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namereport_jobs
TypeResource
Idsumologic.dashboards.report_jobs
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `generateDashboardReport` | `EXEC` | `data__action, data__exportFormat, data__template, data__timezone, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_result/index.md b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_result/index.md index 4a698541be..46849769a3 100644 --- a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_result/index.md +++ b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_result/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namereport_jobs_result
TypeResource
Idsumologic.dashboards.report_jobs_result
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncReportGenerationResult` | `EXEC` | `jobId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_status/index.md b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_status/index.md index 45e84650b6..4a57c2d5a8 100644 --- a/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/dashboards/report_jobs_status/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namereport_jobs_status
TypeResource
Idsumologic.dashboards.report_jobs_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `status` | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | -| `statusMessage` | `string` | Additional status message generated if the status is not `Failed`. | -| `error` | `object` | | +| | `object` | | +| | `string` | Whether or not the request is in progress (`InProgress`), has completed successfully (`Success`), or has completed with an error (`Failed`). | +| | `string` | Additional status message generated if the status is not `Failed`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAsyncReportGenerationStatus` | `SELECT` | `jobId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/dynamic_parsing_rules/index.md b/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/dynamic_parsing_rules/index.md index bd9a811ab8..a50d8dcfc2 100644 --- a/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/dynamic_parsing_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/dynamic_parsing_rules/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedynamic_parsing_rules
TypeResource
Idsumologic.dynamic_parsing_rules.dynamic_parsing_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the dynamic parsing rule. | -| `name` | `string` | Name of the dynamic parsing rule. Use a name that makes it easy to identify the rule. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `scope` | `string` | Scope of the dynamic parsing rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( \| ). You'll use the Scope to run a search against the rule. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `isSystemRule` | `boolean` | Whether the rule has been defined by the system, rather than by a user. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `enabled` | `boolean` | Is the dynamic parsing rule enabled. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Unique identifier for the dynamic parsing rule. | +| | `string` | Name of the dynamic parsing rule. Use a name that makes it easy to identify the rule. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | Is the dynamic parsing rule enabled. | +| | `boolean` | Whether the rule has been defined by the system, rather than by a user. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Scope of the dynamic parsing rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( \| ). You'll use the Scope to run a search against the rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDynamicParsingRule` | `SELECT` | `id, region` | Get a dynamic parsing rule with the given identifier. | -| `listDynamicParsingRules` | `SELECT` | `region` | Get a list of all dynamic parsing rules. The response is paginated with a default limit of 100 dynamic parsing rules per page. | -| `createDynamicParsingRule` | `INSERT` | `data__enabled, data__name, data__scope, region` | Create a new dynamic parsing rule. | -| `deleteDynamicParsingRule` | `DELETE` | `id, region` | Delete a dynamic parsing rule with the given identifier. | -| `updateDynamicParsingRule` | `EXEC` | `id, data__enabled, data__name, data__scope, region` | Update an existing dynamic parsing rule. All properties specified in the request are replaced. Missing properties are set to their default values. | +| | `SELECT` | | Get a dynamic parsing rule with the given identifier. | +| | `SELECT` | | Get a list of all dynamic parsing rules. The response is paginated with a default limit of 100 dynamic parsing rules per page. | +| | `INSERT` | | Create a new dynamic parsing rule. | +| | `DELETE` | | Delete a dynamic parsing rule with the given identifier. | +| | `EXEC` | | Update an existing dynamic parsing rule. All properties specified in the request are replaced. Missing properties are set to their default values. | diff --git a/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/index.md b/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/index.md index 14ac494e0d..2e785beeaa 100644 --- a/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/dynamic_parsing_rules/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + dynamicParsingRules :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/extraction_rules/extraction_rules/index.md b/docs/sumologic-docs/providers/sumologic/extraction_rules/extraction_rules/index.md index 9a0bb14dde..d8d58f623e 100644 --- a/docs/sumologic-docs/providers/sumologic/extraction_rules/extraction_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/extraction_rules/extraction_rules/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameextraction_rules
TypeResource
Idsumologic.extraction_rules.extraction_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the field extraction rule. | -| `name` | `string` | Name of the field extraction rule. Use a name that makes it easy to identify the rule. | -| `scope` | `string` | Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( \| ). You'll use the Scope to run a search against the rule. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `enabled` | `boolean` | Is the field extraction rule enabled. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `parseExpression` | `string` | Describes the fields to be parsed. | -| `fieldNames` | `array` | List of extracted fields from "parseExpression". | +| | `string` | Unique identifier for the field extraction rule. | +| | `string` | Name of the field extraction rule. Use a name that makes it easy to identify the rule. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | Is the field extraction rule enabled. | +| | `array` | List of extracted fields from "parseExpression". | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Describes the fields to be parsed. | +| | `string` | Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( \| ). You'll use the Scope to run a search against the rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getExtractionRule` | `SELECT` | `id, region` | Get a field extraction rule with the given identifier. | -| `listExtractionRules` | `SELECT` | `region` | Get a list of all field extraction rules. The response is paginated with a default limit of 100 field extraction rules per page. | -| `createExtractionRule` | `INSERT` | `region` | Create a new field extraction rule. | -| `deleteExtractionRule` | `DELETE` | `id, region` | Delete a field extraction rule with the given identifier. | -| `updateExtractionRule` | `EXEC` | `id, region` | Update an existing field extraction rule. All properties specified in the request are replaced. Missing properties are set to their default values. | +| | `SELECT` | | Get a field extraction rule with the given identifier. | +| | `SELECT` | | Get a list of all field extraction rules. The response is paginated with a default limit of 100 field extraction rules per page. | +| | `INSERT` | | Create a new field extraction rule. | +| | `DELETE` | | Delete a field extraction rule with the given identifier. | +| | `EXEC` | | Update an existing field extraction rule. All properties specified in the request are replaced. Missing properties are set to their default values. | diff --git a/docs/sumologic-docs/providers/sumologic/extraction_rules/index.md b/docs/sumologic-docs/providers/sumologic/extraction_rules/index.md index 9d0f6216c8..d20d79ad0b 100644 --- a/docs/sumologic-docs/providers/sumologic/extraction_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/extraction_rules/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + extractionRules :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/fields/builtin/index.md b/docs/sumologic-docs/providers/sumologic/fields/builtin/index.md index 6ec175e7c2..3c5ac44778 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/builtin/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/builtin/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuiltin
TypeResource
Idsumologic.fields.builtin
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fieldId` | `string` | Identifier of the field. | -| `state` | `string` | Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`. | -| `fieldName` | `string` | Field name. | -| `dataType` | `string` | Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`. | +| | `string` | Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`. | +| | `string` | Identifier of the field. | +| | `string` | Field name. | +| | `string` | Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getBuiltInField` | `SELECT` | `id, region` | Get the details of a built-in field. | -| `listBuiltInFields` | `SELECT` | `region` | Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include `_sourceHost` and `_sourceCategory`. Built-in fields can't be deleted or disabled. | +| | `SELECT` | | Get the details of a built-in field. | +| | `SELECT` | | Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include `_sourceHost` and `_sourceCategory`. Built-in fields can't be deleted or disabled. | diff --git a/docs/sumologic-docs/providers/sumologic/fields/disable/index.md b/docs/sumologic-docs/providers/sumologic/fields/disable/index.md index ba9920bbd3..9404678eb2 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedisable
TypeResource
Idsumologic.fields.disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableField` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/fields/dropped/index.md b/docs/sumologic-docs/providers/sumologic/fields/dropped/index.md index e3cc40e48d..73f2bb7377 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/dropped/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/dropped/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedropped
TypeResource
Idsumologic.fields.dropped
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listDroppedFields` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/fields/enable/index.md b/docs/sumologic-docs/providers/sumologic/fields/enable/index.md index b79683233e..8b2a34a332 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/enable/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/enable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameenable
TypeResource
Idsumologic.fields.enable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enableField` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/fields/fields/index.md b/docs/sumologic-docs/providers/sumologic/fields/fields/index.md index c1d06bf87d..a4d2c6e67c 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/fields/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/fields/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefields
TypeResource
Idsumologic.fields.fields
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fieldId` | `string` | Identifier of the field. | -| `state` | `string` | Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`. | -| `fieldName` | `string` | Field name. | -| `dataType` | `string` | Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`. | +| | `string` | Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`. | +| | `string` | Identifier of the field. | +| | `string` | Field name. | +| | `string` | Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getCustomField` | `SELECT` | `id, region` | Get the details of a custom field. | -| `listCustomFields` | `SELECT` | `region` | Request a list of all the custom fields configured in your account. | -| `createField` | `INSERT` | `data__fieldName, region` | Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs. | -| `deleteField` | `DELETE` | `id, region` | Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field. | +| | `SELECT` | | Get the details of a custom field. | +| | `SELECT` | | Request a list of all the custom fields configured in your account. | +| | `INSERT` | | Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs. | +| | `DELETE` | | Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field. | diff --git a/docs/sumologic-docs/providers/sumologic/fields/index.md b/docs/sumologic-docs/providers/sumologic/fields/index.md index 333e2b6529..2d3f066dfc 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + fields :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/fields/quota/index.md b/docs/sumologic-docs/providers/sumologic/fields/quota/index.md index d16a873996..aae5c11e27 100644 --- a/docs/sumologic-docs/providers/sumologic/fields/quota/index.md +++ b/docs/sumologic-docs/providers/sumologic/fields/quota/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namequota
TypeResource
Idsumologic.fields.quota
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `quota` | `integer` | Maximum number of fields available. | -| `remaining` | `integer` | Current number of fields available. | +| | `integer` | Maximum number of fields available. | +| | `integer` | Current number of fields available. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getFieldQuota` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/health_events/health_events/index.md b/docs/sumologic-docs/providers/sumologic/health_events/health_events/index.md index f44fd44b7b..c513d81e5f 100644 --- a/docs/sumologic-docs/providers/sumologic/health_events/health_events/index.md +++ b/docs/sumologic-docs/providers/sumologic/health_events/health_events/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehealth_events
TypeResource
Idsumologic.health_events.health_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `eventId` | `string` | The unique identifier of the event. | -| `eventName` | `string` | The name of the event. | -| `eventTime` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `resourceIdentity` | `object` | | -| `severityLevel` | `string` | The criticality of the event. It is either `Error` or `Warning` | -| `subsystem` | `string` | The product area of the event. | -| `details` | `object` | | +| | `object` | | +| | `string` | The unique identifier of the event. | +| | `string` | The name of the event. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `object` | | +| | `string` | The criticality of the event. It is either `Error` or `Warning` | +| | `string` | The product area of the event. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listAllHealthEvents` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/health_events/index.md b/docs/sumologic-docs/providers/sumologic/health_events/index.md index bb9f69d9ac..453af01caf 100644 --- a/docs/sumologic-docs/providers/sumologic/health_events/index.md +++ b/docs/sumologic-docs/providers/sumologic/health_events/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + healthEvents :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/health_events/resources/index.md b/docs/sumologic-docs/providers/sumologic/health_events/resources/index.md index a2a461f2f5..7a4b585a8e 100644 --- a/docs/sumologic-docs/providers/sumologic/health_events/resources/index.md +++ b/docs/sumologic-docs/providers/sumologic/health_events/resources/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameresources
TypeResource
Idsumologic.health_events.resources
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listAllHealthEventsForResources` | `EXEC` | `data__data, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/ingest_budgets/collectors/index.md b/docs/sumologic-docs/providers/sumologic/ingest_budgets/collectors/index.md index 45df4e7399..d6ddfc580f 100644 --- a/docs/sumologic-docs/providers/sumologic/ingest_budgets/collectors/index.md +++ b/docs/sumologic-docs/providers/sumologic/ingest_budgets/collectors/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecollectors
TypeResource
Idsumologic.ingest_budgets.collectors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the Collector. | -| `name` | `string` | The name of the Collector. | +| | `string` | Unique identifier for the Collector. | +| | `string` | The name of the Collector. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAssignedCollectors` | `SELECT` | `id, region` | Get a list of Collectors assigned to an ingest budget. The response is paginated with a default limit of 100 Collectors per page. | -| `removeCollectorFromBudget` | `DELETE` | `collectorId, id, region` | Remove Collector from a budget. | -| `assignCollectorToBudget` | `EXEC` | `collectorId, id, region` | Assign a Collector to a budget. | +| | `SELECT` | | Get a list of Collectors assigned to an ingest budget. The response is paginated with a default limit of 100 Collectors per page. | +| | `DELETE` | | Remove Collector from a budget. | +| | `EXEC` | | Assign a Collector to a budget. | diff --git a/docs/sumologic-docs/providers/sumologic/ingest_budgets/index.md b/docs/sumologic-docs/providers/sumologic/ingest_budgets/index.md index 500528dce7..007f3e651c 100644 --- a/docs/sumologic-docs/providers/sumologic/ingest_budgets/index.md +++ b/docs/sumologic-docs/providers/sumologic/ingest_budgets/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + ingestBudgets :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v1/index.md b/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v1/index.md index e4d3ea31d7..0d78984b54 100644 --- a/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v1/index.md +++ b/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v1/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameingest_budgets_v1
TypeResource
Idsumologic.ingest_budgets.ingest_budgets_v1
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the ingest budget. | -| `name` | `string` | Display name of the ingest budget. | -| `description` | `string` | Description of the ingest budget. | -| `timezone` | `string` | Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | -| `auditThreshold` | `integer` | The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. | -| `capacityBytes` | `integer` | Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. | -| `usageStatus` | `string` | Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage). | -| `modifiedAt` | `string` | Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `action` | `string` | Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:
* `stopCollecting`
* `keepCollecting` | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `fieldValue` | `string` | Custom field value that is used to assign Collectors to the ingest budget. | -| `numberOfCollectors` | `integer` | Number of collectors assigned to the ingest budget. | -| `modifiedByUser` | `object` | | -| `usageBytes` | `integer` | Current usage since the last reset, in bytes. | -| `createdByUser` | `object` | | -| `resetTime` | `string` | Reset time of the ingest budget in HH:MM format. | +| | `string` | Unique identifier for the ingest budget. | +| | `string` | Display name of the ingest budget. | +| | `string` | Description of the ingest budget. | +| | `string` | Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:
* `stopCollecting`
* `keepCollecting` | +| | `integer` | The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. | +| | `integer` | Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `object` | | +| | `string` | Custom field value that is used to assign Collectors to the ingest budget. | +| | `string` | Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `object` | | +| | `integer` | Number of collectors assigned to the ingest budget. | +| | `string` | Reset time of the ingest budget in HH:MM format. | +| | `string` | Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | +| | `integer` | Current usage since the last reset, in bytes. | +| | `string` | Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getIngestBudget` | `SELECT` | `id, region` | Get an ingest budget by the given identifier. | -| `listIngestBudgets` | `SELECT` | `region` | Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. | -| `createIngestBudget` | `INSERT` | `data__action, data__capacityBytes, data__fieldValue, data__name, data__resetTime, data__timezone, region` | Create a new ingest budget. | -| `deleteIngestBudget` | `DELETE` | `id, region` | Delete an ingest budget with the given identifier. | -| `updateIngestBudget` | `EXEC` | `id, data__action, data__capacityBytes, data__fieldValue, data__name, data__resetTime, data__timezone, region` | Update an existing ingest budget. All properties specified in the request are required. | +| | `SELECT` | | Get an ingest budget by the given identifier. | +| | `SELECT` | | Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. | +| | `INSERT` | | Create a new ingest budget. | +| | `DELETE` | | Delete an ingest budget with the given identifier. | +| | `EXEC` | | Update an existing ingest budget. All properties specified in the request are required. | diff --git a/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v2/index.md b/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v2/index.md index d9ff7d9b32..42b046ddfd 100644 --- a/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v2/index.md +++ b/docs/sumologic-docs/providers/sumologic/ingest_budgets/ingest_budgets_v2/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameingest_budgets_v2
TypeResource
Idsumologic.ingest_budgets.ingest_budgets_v2
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the ingest budget. | -| `name` | `string` | Display name of the ingest budget. | -| `description` | `string` | Description of the ingest budget. | -| `modifiedBy` | `string` | The identifier of the user who modified the Ingest Budget. | -| `createdAt` | `string` | The creation timestamp in UTC of the Ingest Budget. | -| `auditThreshold` | `integer` | The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. | -| `scope` | `string` | A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. Value supports wildcard. e.g. _sourceCategory=*prod*payment*, cluster=kafka. If the scope is defined _sourceCategory=*nginx* in this budget will be applied on messages having fields _sourceCategory=prod/nginx, _sourceCategory=dev/nginx, or _sourceCategory=dev/nginx/error | -| `budgetVersion` | `integer` | The version of the Ingest Budget | -| `timezone` | `string` | Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | -| `capacityBytes` | `integer` | Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. | -| `action` | `string` | Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:
* `stopCollecting`
* `keepCollecting` | -| `usageStatus` | `string` | Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage). | -| `usageBytes` | `integer` | Current usage since the last reset, in bytes. | -| `modifiedAt` | `string` | The modified timestamp in UTC of the Ingest Budget. | -| `resetTime` | `string` | Reset time of the ingest budget in HH:MM format. | -| `createdBy` | `string` | The identifier of the user who created the Ingest Budget. | +| | `string` | Unique identifier for the ingest budget. | +| | `string` | Display name of the ingest budget. | +| | `string` | Description of the ingest budget. | +| | `string` | Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:
* `stopCollecting`
* `keepCollecting` | +| | `integer` | The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. | +| | `integer` | The version of the Ingest Budget | +| | `integer` | Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. | +| | `string` | The creation timestamp in UTC of the Ingest Budget. | +| | `string` | The identifier of the user who created the Ingest Budget. | +| | `string` | The modified timestamp in UTC of the Ingest Budget. | +| | `string` | The identifier of the user who modified the Ingest Budget. | +| | `string` | Reset time of the ingest budget in HH:MM format. | +| | `string` | A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. Value supports wildcard. e.g. _sourceCategory=*prod*payment*, cluster=kafka. If the scope is defined _sourceCategory=*nginx* in this budget will be applied on messages having fields _sourceCategory=prod/nginx, _sourceCategory=dev/nginx, or _sourceCategory=dev/nginx/error | +| | `string` | Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | +| | `integer` | Current usage since the last reset, in bytes. | +| | `string` | Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getIngestBudgetV2` | `SELECT` | `id, region` | Get an ingest budget by the given identifier. | -| `listIngestBudgetsV2` | `SELECT` | `region` | Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. | -| `createIngestBudgetV2` | `INSERT` | `data__action, data__capacityBytes, data__name, data__resetTime, data__scope, data__timezone, region` | Create a new ingest budget. | -| `deleteIngestBudgetV2` | `DELETE` | `id, region` | Delete an ingest budget with the given identifier. | -| `updateIngestBudgetV2` | `EXEC` | `id, data__action, data__capacityBytes, data__name, data__resetTime, data__scope, data__timezone, region` | Update an existing ingest budget. All properties specified in the request are required. | +| | `SELECT` | | Get an ingest budget by the given identifier. | +| | `SELECT` | | Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. | +| | `INSERT` | | Create a new ingest budget. | +| | `DELETE` | | Delete an ingest budget with the given identifier. | +| | `EXEC` | | Update an existing ingest budget. All properties specified in the request are required. | diff --git a/docs/sumologic-docs/providers/sumologic/ingest_budgets/usage_reset/index.md b/docs/sumologic-docs/providers/sumologic/ingest_budgets/usage_reset/index.md index 98bf074c53..a55655b910 100644 --- a/docs/sumologic-docs/providers/sumologic/ingest_budgets/usage_reset/index.md +++ b/docs/sumologic-docs/providers/sumologic/ingest_budgets/usage_reset/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_reset
TypeResource
Idsumologic.ingest_budgets.usage_reset
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `resetUsage` | `EXEC` | `id, region` | -| `resetUsageV2` | `EXEC` | `id, region` | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage/index.md b/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage/index.md index 93a62131ff..9f5b58e9d7 100644 --- a/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage/index.md +++ b/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameestimated_usage
TypeResource
Idsumologic.log_searches.estimated_usage
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLogSearchEstimatedUsage` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage_by_tier/index.md b/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage_by_tier/index.md index 049bb5a7ca..7eb72236b5 100644 --- a/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage_by_tier/index.md +++ b/docs/sumologic-docs/providers/sumologic/log_searches/estimated_usage_by_tier/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameestimated_usage_by_tier
TypeResource
Idsumologic.log_searches.estimated_usage_by_tier
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getLogSearchEstimatedUsageByTier` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/log_searches/index.md b/docs/sumologic-docs/providers/sumologic/log_searches/index.md index 6eb6c39c21..8e501ef947 100644 --- a/docs/sumologic-docs/providers/sumologic/log_searches/index.md +++ b/docs/sumologic-docs/providers/sumologic/log_searches/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + logSearches :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/destinations/index.md b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/destinations/index.md index 4c822153fc..0505dc1ad2 100644 --- a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/destinations/index.md +++ b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/destinations/index.md @@ -14,40 +14,43 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedestinations
TypeResource
Idsumologic.logs_data_forwarding.destinations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the data forwarding destination. | -| `description` | `string` | Description of the S3 data forwarding destination. | -| `authenticationMode` | `string` | AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased` | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `bucketName` | `string` | The name of the Amazon S3 bucket. | -| `secretAccessKey` | `string` | The AWS Secret Key to access the S3 bucket. | -| `region` | `string` | The region where the S3 bucket is located. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `encrypted` | `boolean` | Enable S3 server-side encryption. | -| `accessKeyId` | `string` | The AWS Access ID to access the S3 bucket. | -| `enabled` | `boolean` | True if the destination is Active. | -| `roleArn` | `string` | The AWS Role ARN to access the S3 bucket. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `invalidatedBySystem` | `boolean` | True if invalidated by the system. | -| `destinationName` | `string` | Name of the S3 data forwarding destination. | +| | `string` | The unique identifier of the data forwarding destination. | +| | `string` | Description of the S3 data forwarding destination. | +| | `string` | The AWS Access ID to access the S3 bucket. | +| | `string` | AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased` | +| | `string` | The name of the Amazon S3 bucket. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Name of the S3 data forwarding destination. | +| | `boolean` | True if the destination is Active. | +| | `boolean` | Enable S3 server-side encryption. | +| | `boolean` | True if invalidated by the system. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | The region where the S3 bucket is located. | +| | `string` | The AWS Role ARN to access the S3 bucket. | +| | `string` | The AWS Secret Key to access the S3 bucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDataForwardingBuckets` | `SELECT` | `region` | Get a list of all Amazon S3 data forwarding destinations. | -| `getDataForwardingDestination` | `SELECT` | `id, region` | Get an S3 data forwarding destination by the given identifier. | -| `createDataForwardingBucket` | `INSERT` | `region` | Create a new Amazon S3 data forwarding destination. | -| `deleteDataForwardingBucket` | `DELETE` | `id, region` | Delete an existing Amazon S3 data forwarding destination with the given identifier. | -| `UpdateDataForwardingBucket` | `EXEC` | `id, data__authenticationMode, region` | Update an S3 data forwarding destination by the given identifier. | +| | `SELECT` | | Get a list of all Amazon S3 data forwarding destinations. | +| | `SELECT` | | Get an S3 data forwarding destination by the given identifier. | +| | `INSERT` | | Create a new Amazon S3 data forwarding destination. | +| | `DELETE` | | Delete an existing Amazon S3 data forwarding destination with the given identifier. | +| | `EXEC` | | Update an S3 data forwarding destination by the given identifier. | diff --git a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/index.md b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/index.md index 10c3446616..06899b6313 100644 --- a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/index.md +++ b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + logsDataForwarding :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/rules/index.md b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/rules/index.md index 6123880e61..5a15f922e2 100644 --- a/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/logs_data_forwarding/rules/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idsumologic.logs_data_forwarding.rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the data forwarding rule. | -| `indexId` | `string` | The `id` of the Partition or Scheduled View the rule applies to. | -| `bucket` | `object` | | -| `enabled` | `boolean` | True when the data forwarding rule is enabled. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `format` | `string` | Format of the payload. | -| `destinationId` | `string` | The data forwarding destination id. | -| `fileFormat` | `string` | Specify the path prefix to a directory in the S3 bucket and how to format the file name. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `payloadSchema` | `string` | Schema for the payload. | +| | `string` | The unique identifier of the data forwarding rule. | +| | `object` | | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | The data forwarding destination id. | +| | `boolean` | True when the data forwarding rule is enabled. | +| | `string` | Specify the path prefix to a directory in the S3 bucket and how to format the file name. | +| | `string` | Format of the payload. | +| | `string` | The `id` of the Partition or Scheduled View the rule applies to. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Schema for the payload. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDataForwardingRule` | `SELECT` | `indexId, region` | Get the details of an S3 data forwarding rule by its Partition or Scheduled View identifier. | -| `getRulesAndBuckets` | `SELECT` | `region` | Get a list of all S3 data forwarding rules. | -| `createDataForwardingRule` | `INSERT` | `data__destinationId, data__indexId, region` | Create a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket. | -| `deleteDataForwardingRule` | `DELETE` | `indexId, region` | Delete an S3 data forwarding rule by its Partition or Scheduled View identifier. | -| `updateDataForwardingRule` | `EXEC` | `indexId, region` | Update an S3 data forwarding rule by its Partition or Scheduled View identifier. | +| | `SELECT` | | Get the details of an S3 data forwarding rule by its Partition or Scheduled View identifier. | +| | `SELECT` | | Get a list of all S3 data forwarding rules. | +| | `INSERT` | | Create a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket. | +| | `DELETE` | | Delete an S3 data forwarding rule by its Partition or Scheduled View identifier. | +| | `EXEC` | | Update an S3 data forwarding rule by its Partition or Scheduled View identifier. | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/delete_table_row/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/delete_table_row/index.md index eb33a7f704..e975c5ecef 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/delete_table_row/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/delete_table_row/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedelete_table_row
TypeResource
Idsumologic.lookup_tables.delete_table_row
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `deleteTableRow` | `EXEC` | `id, data__primaryKey, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/index.md index 1343e4b409..cf7f83723d 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + lookupTables :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/jobs_status/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/jobs_status/index.md index 579e681864..90fcc9a744 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/jobs_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/jobs_status/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namejobs_status
TypeResource
Idsumologic.lookup_tables.jobs_status
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `requestJobStatus` | `EXEC` | `jobId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/lookup_tables/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/lookup_tables/index.md index 5e011b9348..b2c45101f4 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/lookup_tables/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/lookup_tables/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelookup_tables
TypeResource
Idsumologic.lookup_tables.lookup_tables
Id
## Fields @@ -29,7 +32,7 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `createTable` | `INSERT` | `data__name, data__parentFolderId, region` | Create a new lookup table by providing a schema and specifying its configuration. Providing parentFolderId
is mandatory. Use the [getItemByPath](#operation/getItemByPath) endpoint to get content id of a path.
Please check [Content management API](#tag/contentManagement) and [Folder management API](#tag/folderManagement) for all available options. | -| `deleteTable` | `DELETE` | `id, region` | Delete a lookup table completely. <br> **Warning:** `This operation cannot be undone`. | -| `lookupTableById` | `EXEC` | `id, region` | Get a lookup table for the given identifier. | -| `updateTable` | `EXEC` | `id, data__description, data__ttl, region` | Edit the lookup table data. All the fields are mandatory in the request. | +| | `INSERT` | | Create a new lookup table by providing a schema and specifying its configuration. Providing parentFolderId
is mandatory. Use the [getItemByPath](#operation/getItemByPath) endpoint to get content id of a path.
Please check [Content management API](#tag/contentManagement) and [Folder management API](#tag/folderManagement) for all available options. | +| | `DELETE` | | Delete a lookup table completely. <br> **Warning:** `This operation cannot be undone`. | +| | `EXEC` | | Get a lookup table for the given identifier. | +| | `EXEC` | | Edit the lookup table data. All the fields are mandatory in the request. | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/row/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/row/index.md index 1fd1e20096..f04fc65bc0 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/row/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/row/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerow
TypeResource
Idsumologic.lookup_tables.row
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `updateTableRow` | `EXEC` | `id, data__row, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/truncate/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/truncate/index.md index 93a96057d5..472e115c3b 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/truncate/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/truncate/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametruncate
TypeResource
Idsumologic.lookup_tables.truncate
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `truncateTable` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/lookup_tables/upload/index.md b/docs/sumologic-docs/providers/sumologic/lookup_tables/upload/index.md index 1caaf2248e..cbbdb73187 100644 --- a/docs/sumologic-docs/providers/sumologic/lookup_tables/upload/index.md +++ b/docs/sumologic-docs/providers/sumologic/lookup_tables/upload/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameupload
TypeResource
Idsumologic.lookup_tables.upload
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `uploadFile` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/metrics_queries/index.md b/docs/sumologic-docs/providers/sumologic/metrics_queries/index.md index f409dd322b..a746fb047b 100644 --- a/docs/sumologic-docs/providers/sumologic/metrics_queries/index.md +++ b/docs/sumologic-docs/providers/sumologic/metrics_queries/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + metricsQueries :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/metrics_queries/metrics_queries/index.md b/docs/sumologic-docs/providers/sumologic/metrics_queries/metrics_queries/index.md index fa941c9e25..635fc86f65 100644 --- a/docs/sumologic-docs/providers/sumologic/metrics_queries/metrics_queries/index.md +++ b/docs/sumologic-docs/providers/sumologic/metrics_queries/metrics_queries/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_queries
TypeResource
Idsumologic.metrics_queries.metrics_queries
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `runMetricsQueries` | `EXEC` | `data__queries, data__timeRange, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/metrics_searches/index.md b/docs/sumologic-docs/providers/sumologic/metrics_searches/index.md index 791af97c60..55223a49a1 100644 --- a/docs/sumologic-docs/providers/sumologic/metrics_searches/index.md +++ b/docs/sumologic-docs/providers/sumologic/metrics_searches/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + metricsSearches :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/metrics_searches/metrics_searches/index.md b/docs/sumologic-docs/providers/sumologic/metrics_searches/metrics_searches/index.md index 9e5e0a972e..2d4fc8ebbb 100644 --- a/docs/sumologic-docs/providers/sumologic/metrics_searches/metrics_searches/index.md +++ b/docs/sumologic-docs/providers/sumologic/metrics_searches/metrics_searches/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_searches
TypeResource
Idsumologic.metrics_searches.metrics_searches
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the metrics search. | -| `description` | `string` | Item description in the content library. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `timeRange` | `object` | | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `logQuery` | `string` | Log query used to add an overlay to the chart. | -| `metricsQueries` | `array` | Metrics queries, up to the maximum of six. | -| `properties` | `string` | Chart properties, like line width, color palette, and the fill missing data method. Leave this field empty to use the defaults.
This property contains JSON object encoded as a string.
| -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `parentId` | `string` | Identifier of the parent element in the content library, such as folder. | -| `desiredQuantizationInSecs` | `integer` | Desired quantization in seconds. | -| `title` | `string` | Item title in the content library. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the metrics search. | +| | `string` | Item description in the content library. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `integer` | Desired quantization in seconds. | +| | `string` | Log query used to add an overlay to the chart. | +| | `array` | Metrics queries, up to the maximum of six. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent element in the content library, such as folder. | +| | `string` | Chart properties, like line width, color palette, and the fill missing data method. Leave this field empty to use the defaults.
This property contains JSON object encoded as a string.
| +| | `object` | | +| | `string` | Item title in the content library. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getMetricsSearch` | `SELECT` | `id, region` | Returns a metrics search with the specified identifier. | -| `createMetricsSearch` | `INSERT` | `region` | Saves a metrics search in the content library. Metrics search consists of one or more queries, a time range, a quantization period and a set of chart properties like line width. | -| `deleteMetricsSearch` | `DELETE` | `id, region` | Deletes a metrics search from the content library. | -| `updateMetricsSearch` | `EXEC` | `id, data__description, data__metricsQueries, data__timeRange, data__title, region` | Updates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields. | +| | `SELECT` | | Returns a metrics search with the specified identifier. | +| | `INSERT` | | Saves a metrics search in the content library. Metrics search consists of one or more queries, a time range, a quantization period and a set of chart properties like line width. | +| | `DELETE` | | Deletes a metrics search from the content library. | +| | `EXEC` | | Updates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields. | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/copy/index.md b/docs/sumologic-docs/providers/sumologic/monitors/copy/index.md index 39cdb8a427..9f7c77a51e 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/copy/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/copy/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecopy
TypeResource
Idsumologic.monitors.copy
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsCopy` | `EXEC` | `id, data__parentId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/disable/index.md b/docs/sumologic-docs/providers/sumologic/monitors/disable/index.md index 188018e52b..55f6e85f54 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedisable
TypeResource
Idsumologic.monitors.disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableMonitorByIds` | `EXEC` | `ids, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/export/index.md b/docs/sumologic-docs/providers/sumologic/monitors/export/index.md index a7da361abe..be10e38d6a 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/export/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/export/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameexport
TypeResource
Idsumologic.monitors.export
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsExportItem` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/import/index.md b/docs/sumologic-docs/providers/sumologic/monitors/import/index.md index 91f8492290..7e8a7fd72f 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/import/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/import/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimport
TypeResource
Idsumologic.monitors.import
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsImportItem` | `EXEC` | `parentId, data__name, data__type, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/index.md b/docs/sumologic-docs/providers/sumologic/monitors/index.md index 5ef7050713..6a9e105db5 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + monitors :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/monitors/monitors/index.md b/docs/sumologic-docs/providers/sumologic/monitors/monitors/index.md index 445d66e766..f95eecedfd 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/monitors/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/monitors/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemonitors
TypeResource
Idsumologic.monitors.monitors
Id
## Fields @@ -29,9 +32,9 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `monitorsCreate` | `EXEC` | `parentId, data__name, data__type, region` | Create a monitor or folder in the monitors library. | -| `monitorsDeleteById` | `EXEC` | `id, region` | Delete a monitor or folder from the monitors library. | -| `monitorsDeleteByIds` | `EXEC` | `ids, region` | Bulk delete a monitor or folder by the given identifiers in the monitors library. | -| `monitorsReadById` | `EXEC` | `id, region` | Get a monitor or folder from the monitors library. | -| `monitorsReadByIds` | `EXEC` | `ids, region` | Bulk read a monitor or folder by the given identifiers from the monitors library. | -| `monitorsUpdateById` | `EXEC` | `id, data__name, data__type, data__version, region` | Update a monitor or folder in the monitors library. | +| | `EXEC` | | Create a monitor or folder in the monitors library. | +| | `EXEC` | | Delete a monitor or folder from the monitors library. | +| | `EXEC` | | Bulk delete a monitor or folder by the given identifiers in the monitors library. | +| | `EXEC` | | Get a monitor or folder from the monitors library. | +| | `EXEC` | | Bulk read a monitor or folder by the given identifiers from the monitors library. | +| | `EXEC` | | Update a monitor or folder in the monitors library. | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/move/index.md b/docs/sumologic-docs/providers/sumologic/monitors/move/index.md index b8c0b8ef7a..6ab38d40b2 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/move/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/move/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemove
TypeResource
Idsumologic.monitors.move
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsMove` | `EXEC` | `id, parentId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/path/index.md b/docs/sumologic-docs/providers/sumologic/monitors/path/index.md index 480c405500..0356be7a63 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/path/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/path/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepath
TypeResource
Idsumologic.monitors.path
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `path` | `string` | String representation of the path. | -| `pathItems` | `array` | Elements of the path. | +| | `string` | String representation of the path. | +| | `array` | Elements of the path. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getMonitorsFullPath` | `SELECT` | `id, region` | Get the full path of the monitor or folder in the monitors library. | -| `monitorsGetByPath` | `EXEC` | `path, region` | Read a monitor or folder by its path in the monitors library structure. | +| | `SELECT` | | Get the full path of the monitor or folder in the monitors library. | +| | `EXEC` | | Read a monitor or folder by its path in the monitors library structure. | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/permission_summaries_by_subjects/index.md b/docs/sumologic-docs/providers/sumologic/monitors/permission_summaries_by_subjects/index.md index 806ec5cd83..afb5e0d4c5 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/permission_summaries_by_subjects/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/permission_summaries_by_subjects/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermission_summaries_by_subjects
TypeResource
Idsumologic.monitors.permission_summaries_by_subjects
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsReadPermissionSummariesByIdGroupBySubjects` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/permissions/index.md b/docs/sumologic-docs/providers/sumologic/monitors/permissions/index.md index 778f1ed80a..7a0061a80e 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/permissions/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/permissions/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions
TypeResource
Idsumologic.monitors.permissions
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsReadPermissionsById` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/permissions_revoke/index.md b/docs/sumologic-docs/providers/sumologic/monitors/permissions_revoke/index.md index 80a48b13d4..9310c6664a 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/permissions_revoke/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/permissions_revoke/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions_revoke
TypeResource
Idsumologic.monitors.permissions_revoke
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsRevokePermissions` | `EXEC` | `data__permissionIdentifiers, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/permissions_set/index.md b/docs/sumologic-docs/providers/sumologic/monitors/permissions_set/index.md index 766eac2616..f2a85c5bde 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/permissions_set/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/permissions_set/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions_set
TypeResource
Idsumologic.monitors.permissions_set
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsSetPermissions` | `EXEC` | `data__permissionStatementDefinitions, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/root/index.md b/docs/sumologic-docs/providers/sumologic/monitors/root/index.md index a0cae97f51..630f13e59e 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/root/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/root/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroot
TypeResource
Idsumologic.monitors.root
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the monitor or folder. | -| `name` | `string` | Identifier of the monitor or folder. | -| `description` | `string` | Description of the monitor or folder. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `type` | `string` | Type of the object model. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `parentId` | `string` | Identifier of the parent folder. | -| `contentType` | `string` | Type of the content. Valid values:
1) Monitor
2) Folder | -| `children` | `array` | Children of the folder. NOTE: Permissions field will not be filled (empty list) for children. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `permissions` | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | -| `version` | `integer` | Version of the monitor or folder. | -| `isSystem` | `boolean` | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. | -| `_permissions` | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | -| `isMutable` | `boolean` | Immutable objects are "READ-ONLY". | +| | `string` | Identifier of the monitor or folder. | +| | `string` | Identifier of the monitor or folder. | +| | `string` | Description of the monitor or folder. | +| | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | +| | `array` | Children of the folder. NOTE: Permissions field will not be filled (empty list) for children. | +| | `string` | Type of the content. Valid values:
1) Monitor
2) Folder | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | Immutable objects are "READ-ONLY". | +| | `boolean` | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent folder. | +| | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | +| | `string` | Type of the object model. | +| | `integer` | Version of the monitor or folder. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getMonitorsLibraryRoot` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/search/index.md b/docs/sumologic-docs/providers/sumologic/monitors/search/index.md index 956766280f..6b03ca545b 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/search/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/search/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesearch
TypeResource
Idsumologic.monitors.search
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `monitorsSearch` | `EXEC` | `query, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/monitors/usage_info/index.md b/docs/sumologic-docs/providers/sumologic/monitors/usage_info/index.md index 5cef29da70..a3341911b3 100644 --- a/docs/sumologic-docs/providers/sumologic/monitors/usage_info/index.md +++ b/docs/sumologic-docs/providers/sumologic/monitors/usage_info/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_info
TypeResource
Idsumologic.monitors.usage_info
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getMonitorUsageInfo` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/partitions/cancel_retention_update/index.md b/docs/sumologic-docs/providers/sumologic/partitions/cancel_retention_update/index.md index 05ff4c599a..7d9bba2946 100644 --- a/docs/sumologic-docs/providers/sumologic/partitions/cancel_retention_update/index.md +++ b/docs/sumologic-docs/providers/sumologic/partitions/cancel_retention_update/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecancel_retention_update
TypeResource
Idsumologic.partitions.cancel_retention_update
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `cancelRetentionUpdate` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/partitions/decommission/index.md b/docs/sumologic-docs/providers/sumologic/partitions/decommission/index.md index 7b4a025ecf..5e9f9a8ffb 100644 --- a/docs/sumologic-docs/providers/sumologic/partitions/decommission/index.md +++ b/docs/sumologic-docs/providers/sumologic/partitions/decommission/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedecommission
TypeResource
Idsumologic.partitions.decommission
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `decommissionPartition` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/partitions/index.md b/docs/sumologic-docs/providers/sumologic/partitions/index.md index 0b9f04d9ba..aae4006d37 100644 --- a/docs/sumologic-docs/providers/sumologic/partitions/index.md +++ b/docs/sumologic-docs/providers/sumologic/partitions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + partitions :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/partitions/partitions/index.md b/docs/sumologic-docs/providers/sumologic/partitions/partitions/index.md index b115b7a68e..6a3a4255d1 100644 --- a/docs/sumologic-docs/providers/sumologic/partitions/partitions/index.md +++ b/docs/sumologic-docs/providers/sumologic/partitions/partitions/index.md @@ -14,39 +14,42 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepartitions
TypeResource
Idsumologic.partitions.partitions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the partition. | -| `name` | `string` | The name of the partition. | -| `isCompliant` | `boolean` | Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later. | -| `routingExpression` | `string` | The query that defines the data to be included in the partition. | -| `isActive` | `boolean` | This has the value `true` if the partition is active and `false` if it has been decommissioned. | -| `totalBytes` | `integer` | Size of data in partition in bytes. | -| `newRetentionPeriod` | `integer` | If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time. | -| `indexType` | `string` | This has the value `DefaultIndex`, `AuditIndex`or `Partition` depending upon the type of partition. | -| `retentionPeriod` | `integer` | The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `analyticsTier` | `string` | The Data Tier where the data in the partition will reside. Possible values are:
1. `continuous`
2. `frequent`
3. `infrequent`
Note: The "infrequent" and "frequent" tiers are only available to Cloud Flex Credits Enterprise Suite accounts. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `retentionEffectiveAt` | `string` | When the newRetentionPeriod will become effective in UTC format. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `dataForwardingId` | `string` | Id of the data forwarding configuration to be used by the partition. | +| | `string` | Unique identifier for the partition. | +| | `string` | The name of the partition. | +| | `string` | The Data Tier where the data in the partition will reside. Possible values are:
1. `continuous`
2. `frequent`
3. `infrequent`
Note: The "infrequent" and "frequent" tiers are only available to Cloud Flex Credits Enterprise Suite accounts. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Id of the data forwarding configuration to be used by the partition. | +| | `string` | This has the value `DefaultIndex`, `AuditIndex`or `Partition` depending upon the type of partition. | +| | `boolean` | This has the value `true` if the partition is active and `false` if it has been decommissioned. | +| | `boolean` | Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `integer` | If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time. | +| | `string` | When the newRetentionPeriod will become effective in UTC format. | +| | `integer` | The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled. | +| | `string` | The query that defines the data to be included in the partition. | +| | `integer` | Size of data in partition in bytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPartition` | `SELECT` | `id, region` | Get a partition with the given identifier from the organization. | -| `listPartitions` | `SELECT` | `region` | Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page. | -| `createPartition` | `INSERT` | `data__name, data__routingExpression, region` | Create a new partition. | -| `updatePartition` | `EXEC` | `id, region` | Update an existing partition in the organization. | +| | `SELECT` | | Get a partition with the given identifier from the organization. | +| | `SELECT` | | Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page. | +| | `INSERT` | | Create a new partition. | +| | `EXEC` | | Update an existing partition in the organization. | diff --git a/docs/sumologic-docs/providers/sumologic/password_policy/index.md b/docs/sumologic-docs/providers/sumologic/password_policy/index.md index 9da56d6b9f..e6f535dff8 100644 --- a/docs/sumologic-docs/providers/sumologic/password_policy/index.md +++ b/docs/sumologic-docs/providers/sumologic/password_policy/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + passwordPolicy :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/password_policy/password_policy/index.md b/docs/sumologic-docs/providers/sumologic/password_policy/password_policy/index.md index 28f61a08a1..4908aa646a 100644 --- a/docs/sumologic-docs/providers/sumologic/password_policy/password_policy/index.md +++ b/docs/sumologic-docs/providers/sumologic/password_policy/password_policy/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepassword_policy
TypeResource
Idsumologic.password_policy.password_policy
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `maxLength` | `integer` | The maximum length of the password. (Setting this to any value other than 128 is no longer supported; this field may be deprecated in the future.) | -| `requireMfa` | `boolean` | If MFA should be required to log in. By default, this field is set to `false`. | -| `rememberMfa` | `boolean` | If MFA should be remembered on the browser. | -| `maxPasswordAgeInDays` | `integer` | Maximum number of days that a password can be used before user is required to change it. Put -1 if the user should not have to change their password. | -| `mustContainSpecialChars` | `boolean` | If the password must contain special characters. | -| `failedLoginResetDurationInMins` | `integer` | The duration of time in minutes that must elapse from the first failed login attempt after which failed login count is reset to 0. | -| `accountLockoutDurationInMins` | `integer` | The duration of time in minutes that a locked-out account remained locked before getting unlocked automatically. | -| `accountLockoutThreshold` | `integer` | Number of failed login attempts allowed before account is locked-out. | -| `minLength` | `integer` | The minimum length of the password. | -| `minUniquePasswords` | `integer` | The minimum number of unique new passwords that a user must use before an old password can be reused. | -| `mustContainDigits` | `boolean` | If the password must contain digits. | -| `mustContainUppercase` | `boolean` | If the password must contain upper case characters. | -| `mustContainLowercase` | `boolean` | If the password must contain lower case characters. | +| | `integer` | The duration of time in minutes that a locked-out account remained locked before getting unlocked automatically. | +| | `integer` | Number of failed login attempts allowed before account is locked-out. | +| | `integer` | The duration of time in minutes that must elapse from the first failed login attempt after which failed login count is reset to 0. | +| | `integer` | The maximum length of the password. (Setting this to any value other than 128 is no longer supported; this field may be deprecated in the future.) | +| | `integer` | Maximum number of days that a password can be used before user is required to change it. Put -1 if the user should not have to change their password. | +| | `integer` | The minimum length of the password. | +| | `integer` | The minimum number of unique new passwords that a user must use before an old password can be reused. | +| | `boolean` | If the password must contain digits. | +| | `boolean` | If the password must contain lower case characters. | +| | `boolean` | If the password must contain special characters. | +| | `boolean` | If the password must contain upper case characters. | +| | `boolean` | If MFA should be remembered on the browser. | +| | `boolean` | If MFA should be required to log in. By default, this field is set to `false`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPasswordPolicy` | `SELECT` | `region` | Get the current password policy. | -| `setPasswordPolicy` | `EXEC` | `region` | Update the current password policy. | +| | `SELECT` | | Get the current password policy. | +| | `EXEC` | | Update the current password policy. | diff --git a/docs/sumologic-docs/providers/sumologic/plan/index.md b/docs/sumologic-docs/providers/sumologic/plan/index.md index db2198c086..9107f145c6 100644 --- a/docs/sumologic-docs/providers/sumologic/plan/index.md +++ b/docs/sumologic-docs/providers/sumologic/plan/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + plan :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/plan/pending_update_request/index.md b/docs/sumologic-docs/providers/sumologic/plan/pending_update_request/index.md index 590af092fa..bc87d2f834 100644 --- a/docs/sumologic-docs/providers/sumologic/plan/pending_update_request/index.md +++ b/docs/sumologic-docs/providers/sumologic/plan/pending_update_request/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepending_update_request
TypeResource
Idsumologic.plan.pending_update_request
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `createdOn` | `string` | The date on which the update request was created. | -| `plan` | `object` | Current plan of the account. | +| | `string` | The date on which the update request was created. | +| | `object` | Current plan of the account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getPendingUpdateRequest` | `SELECT` | `region` | Get the pending plan update request which will be applicable from next billing cycle. | -| `deletePendingUpdateRequest` | `DELETE` | `region` | Delete the pending plan update request which would be applicable from next billing cycle. | +| | `SELECT` | | Get the pending plan update request which will be applicable from next billing cycle. | +| | `DELETE` | | Delete the pending plan update request which would be applicable from next billing cycle. | diff --git a/docs/sumologic-docs/providers/sumologic/policies/audit/index.md b/docs/sumologic-docs/providers/sumologic/policies/audit/index.md index 3c061e54be..d63ef57e79 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/audit/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/audit/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit
TypeResource
Idsumologic.policies.audit
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAuditPolicy` | `SELECT` | `region` | Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index) | -| `setAuditPolicy` | `EXEC` | `data__enabled, region` | Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index) | +| | `SELECT` | | Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index) | +| | `EXEC` | | Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index) | diff --git a/docs/sumologic-docs/providers/sumologic/policies/data_access_level/index.md b/docs/sumologic-docs/providers/sumologic/policies/data_access_level/index.md index 2848aa281c..61f601f46e 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/data_access_level/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/data_access_level/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedata_access_level
TypeResource
Idsumologic.policies.data_access_level
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getDataAccessLevelPolicy` | `SELECT` | `region` | Get the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards) | -| `setDataAccessLevelPolicy` | `EXEC` | `data__enabled, region` | Set the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards) | +| | `SELECT` | | Get the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards) | +| | `EXEC` | | Set the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards) | diff --git a/docs/sumologic-docs/providers/sumologic/policies/index.md b/docs/sumologic-docs/providers/sumologic/policies/index.md index 6325dd9a62..4244c9cc67 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + policies :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/policies/max_user_session_timeout/index.md b/docs/sumologic-docs/providers/sumologic/policies/max_user_session_timeout/index.md index 64cdc1b575..689a019876 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/max_user_session_timeout/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/max_user_session_timeout/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemax_user_session_timeout
TypeResource
Idsumologic.policies.max_user_session_timeout
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getMaxUserSessionTimeoutPolicy` | `SELECT` | `region` | Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) | -| `setMaxUserSessionTimeoutPolicy` | `EXEC` | `data__maxUserSessionTimeout, region` | Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) | +| | `SELECT` | | Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) | +| | `EXEC` | | Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) | diff --git a/docs/sumologic-docs/providers/sumologic/policies/search_audit/index.md b/docs/sumologic-docs/providers/sumologic/policies/search_audit/index.md index 0d39f2620d..7f9c6165ca 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/search_audit/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/search_audit/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesearch_audit
TypeResource
Idsumologic.policies.search_audit
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSearchAuditPolicy` | `SELECT` | `region` | Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index) | -| `setSearchAuditPolicy` | `EXEC` | `data__enabled, region` | Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index) | +| | `SELECT` | | Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index) | +| | `EXEC` | | Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index) | diff --git a/docs/sumologic-docs/providers/sumologic/policies/share_dashboards_outside_organization/index.md b/docs/sumologic-docs/providers/sumologic/policies/share_dashboards_outside_organization/index.md index d6851e288e..15d15e3955 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/share_dashboards_outside_organization/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/share_dashboards_outside_organization/index.md @@ -14,19 +14,22 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameshare_dashboards_outside_organization
TypeResource
Idsumologic.policies.share_dashboards_outside_organization
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getShareDashboardsOutsideOrganizationPolicy` | `SELECT` | `region` | Get the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org) | -| `setShareDashboardsOutsideOrganizationPolicy` | `EXEC` | `data__enabled, region` | Set the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org) | +| | `SELECT` | | Get the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org) | +| | `EXEC` | | Set the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org) | diff --git a/docs/sumologic-docs/providers/sumologic/policies/user_concurrent_sessions_limit/index.md b/docs/sumologic-docs/providers/sumologic/policies/user_concurrent_sessions_limit/index.md index 7bc05dd24c..4749142649 100644 --- a/docs/sumologic-docs/providers/sumologic/policies/user_concurrent_sessions_limit/index.md +++ b/docs/sumologic-docs/providers/sumologic/policies/user_concurrent_sessions_limit/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser_concurrent_sessions_limit
TypeResource
Idsumologic.policies.user_concurrent_sessions_limit
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `enabled` | `boolean` | Whether the User Concurrent Sessions Limit policy is enabled. | -| `maxConcurrentSessions` | `integer` | Maximum number of concurrent sessions a user may have. | +| | `boolean` | Whether the User Concurrent Sessions Limit policy is enabled. | +| | `integer` | Maximum number of concurrent sessions a user may have. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getUserConcurrentSessionsLimitPolicy` | `SELECT` | `region` | Get the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions) | -| `setUserConcurrentSessionsLimitPolicy` | `EXEC` | `data__enabled, region` | Set the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions) | +| | `SELECT` | | Get the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions) | +| | `EXEC` | | Set the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions) | diff --git a/docs/sumologic-docs/providers/sumologic/roles/index.md b/docs/sumologic-docs/providers/sumologic/roles/index.md index 328d5832cb..63c8598aea 100644 --- a/docs/sumologic-docs/providers/sumologic/roles/index.md +++ b/docs/sumologic-docs/providers/sumologic/roles/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + roles :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/roles/roles/index.md b/docs/sumologic-docs/providers/sumologic/roles/roles/index.md index a992af4814..d36108e2a9 100644 --- a/docs/sumologic-docs/providers/sumologic/roles/roles/index.md +++ b/docs/sumologic-docs/providers/sumologic/roles/roles/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroles
TypeResource
Idsumologic.roles.roles
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the role. | -| `name` | `string` | Name of the role. | -| `description` | `string` | Description of the role. | -| `capabilities` | `array` | List of [capabilities](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles/Role-Capabilities) associated with this role. Valid values are
### Data Management
- viewCollectors
- manageCollectors
- manageBudgets
- manageDataVolumeFeed
- viewFieldExtraction
- manageFieldExtractionRules
- manageS3DataForwarding
- manageContent
- dataVolumeIndex
- manageConnections
- viewScheduledViews
- manageScheduledViews
- viewPartitions
- managePartitions
- viewFields
- manageFields
- viewAccountOverview
- manageTokens
- downloadSearchResults

### Entity management
- manageEntityTypeConfig

### Metrics
- metricsTransformation
- metricsExtraction
- metricsRules

### Security
- managePasswordPolicy
- ipAllowlisting
- createAccessKeys
- manageAccessKeys
- manageSupportAccountAccess
- manageAuditDataFeed
- manageSaml
- shareDashboardOutsideOrg
- manageOrgSettings
- changeDataAccessLevel

### Dashboards
- shareDashboardWorld
- shareDashboardAllowlist

### UserManagement
- manageUsersAndRoles

### Observability
- searchAuditIndex
- auditEventIndex

### Cloud SIEM Enterprise
- viewCse

### Alerting
- viewMonitorsV2
- manageMonitorsV2
- viewAlerts | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `systemDefined` | `boolean` | Role is system or user defined. | -| `autofillDependencies` | `boolean` | Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies. | -| `users` | `array` | List of user identifiers to assign the role to. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `filterPredicate` | `string` | A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | +| | `string` | Unique identifier for the role. | +| | `string` | Name of the role. | +| | `string` | Description of the role. | +| | `boolean` | Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies. | +| | `array` | List of [capabilities](https://help.sumologic.com/Manage/Users-and-Roles/Manage-Roles/Role-Capabilities) associated with this role. Valid values are
### Data Management
- viewCollectors
- manageCollectors
- manageBudgets
- manageDataVolumeFeed
- viewFieldExtraction
- manageFieldExtractionRules
- manageS3DataForwarding
- manageContent
- dataVolumeIndex
- manageConnections
- viewScheduledViews
- manageScheduledViews
- viewPartitions
- managePartitions
- viewFields
- manageFields
- viewAccountOverview
- manageTokens
- downloadSearchResults

### Entity management
- manageEntityTypeConfig

### Metrics
- metricsTransformation
- metricsExtraction
- metricsRules

### Security
- managePasswordPolicy
- ipAllowlisting
- createAccessKeys
- manageAccessKeys
- manageSupportAccountAccess
- manageAuditDataFeed
- manageSaml
- shareDashboardOutsideOrg
- manageOrgSettings
- changeDataAccessLevel

### Dashboards
- shareDashboardWorld
- shareDashboardAllowlist

### UserManagement
- manageUsersAndRoles

### Observability
- searchAuditIndex
- auditEventIndex

### Cloud SIEM Enterprise
- viewCse

### Alerting
- viewMonitorsV2
- manageMonitorsV2
- viewAlerts | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `boolean` | Role is system or user defined. | +| | `array` | List of user identifiers to assign the role to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getRole` | `SELECT` | `id, region` | Get a role with the given identifier in the organization. | -| `listRoles` | `SELECT` | `region` | Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page. | -| `createRole` | `INSERT` | `data__name, region` | Create a new role in the organization. | -| `deleteRole` | `DELETE` | `id, region` | Delete a role with the given identifier from the organization. | -| `updateRole` | `EXEC` | `id, data__capabilities, data__description, data__filterPredicate, data__name, data__users, region` | Update an existing role in the organization. | +| | `SELECT` | | Get a role with the given identifier in the organization. | +| | `SELECT` | | Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page. | +| | `INSERT` | | Create a new role in the organization. | +| | `DELETE` | | Delete a role with the given identifier from the organization. | +| | `EXEC` | | Update an existing role in the organization. | diff --git a/docs/sumologic-docs/providers/sumologic/roles/users/index.md b/docs/sumologic-docs/providers/sumologic/roles/users/index.md index 1e5f2748d8..2456109240 100644 --- a/docs/sumologic-docs/providers/sumologic/roles/users/index.md +++ b/docs/sumologic-docs/providers/sumologic/roles/users/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idsumologic.roles.users
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `removeRoleFromUser` | `DELETE` | `roleId, userId, region` | Remove a role from a user in the organization. | -| `assignRoleToUser` | `EXEC` | `roleId, userId, region` | Assign a role to a user in the organization. | +| | `DELETE` | | Remove a role from a user in the organization. | +| | `EXEC` | | Assign a role to a user in the organization. | diff --git a/docs/sumologic-docs/providers/sumologic/saml/allowlisted_users/index.md b/docs/sumologic-docs/providers/sumologic/saml/allowlisted_users/index.md index 4259f3547c..8b1c8272a0 100644 --- a/docs/sumologic-docs/providers/sumologic/saml/allowlisted_users/index.md +++ b/docs/sumologic-docs/providers/sumologic/saml/allowlisted_users/index.md @@ -14,29 +14,32 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameallowlisted_users
TypeResource
Idsumologic.saml.allowlisted_users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `isActive` | `boolean` | Checks if the user is active. | -| `lastLogin` | `string` | Timestamp of the last login of the user. | -| `lastName` | `string` | Last name of the user. | -| `userId` | `string` | Unique identifier of the user. | -| `canManageSaml` | `boolean` | If the user can manage SAML Configurations. | -| `email` | `string` | Email of the user. | -| `firstName` | `string` | First name of the user. | +| | `boolean` | If the user can manage SAML Configurations. | +| | `string` | Email of the user. | +| | `string` | First name of the user. | +| | `boolean` | Checks if the user is active. | +| | `string` | Timestamp of the last login of the user. | +| | `string` | Last name of the user. | +| | `string` | Unique identifier of the user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getAllowlistedUsers` | `SELECT` | `region` | Get a list of allowlisted users. | -| `createAllowlistedUser` | `INSERT` | `userId, region` | Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML. | -| `deleteAllowlistedUser` | `DELETE` | `userId, region` | Remove an allowlisted user requiring them to sign in using SAML. | +| | `SELECT` | | Get a list of allowlisted users. | +| | `INSERT` | | Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML. | +| | `DELETE` | | Remove an allowlisted user requiring them to sign in using SAML. | diff --git a/docs/sumologic-docs/providers/sumologic/saml/identity_providers/index.md b/docs/sumologic-docs/providers/sumologic/saml/identity_providers/index.md index 8033b09c9e..56be38dfbd 100644 --- a/docs/sumologic-docs/providers/sumologic/saml/identity_providers/index.md +++ b/docs/sumologic-docs/providers/sumologic/saml/identity_providers/index.md @@ -14,48 +14,51 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidentity_providers
TypeResource
Idsumologic.saml.identity_providers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier of the SAML Identity Provider. | -| `x509cert1` | `string` | The certificate is used to verify the signature in SAML assertions. | -| `rolesAttribute` | `string` | The role that Sumo Logic will assign to users when they sign in. | -| `disableRequestedAuthnContext` | `boolean` | True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider. | -| `configurationName` | `string` | Name of the SSO policy or another name used to describe the policy internally. | -| `signAuthnRequest` | `boolean` | True if Sumo Logic will send signed Authn requests to the identity provider. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `authnRequestUrl` | `string` | The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider. | -| `spInitiatedLoginPath` | `string` | This property has been deprecated and is no longer used. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `spInitiatedLoginEnabled` | `boolean` | True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in. | -| `assertionConsumerUrl` | `string` | The URL on Sumo Logic where the IdP will redirect to with its authentication response. | -| `isRedirectBinding` | `boolean` | True if the SAML binding is of HTTP Redirect type. | -| `emailAttribute` | `string` | The email address of the new user account. | -| `x509cert2` | `string` | The backup certificate used to verify the signature in SAML assertions when x509cert1 expires. | -| `entityId` | `string` | A unique identifier that is the intended audience of the SAML assertion. | -| `certificate` | `string` | Authentication Request Signing Certificate for the user. | -| `onDemandProvisioningEnabled` | `object` | | -| `debugMode` | `boolean` | True if additional details are included when a user fails to sign in. | -| `logoutUrl` | `string` | The URL that users will be redirected to after signing out of Sumo Logic. | -| `issuer` | `string` | The unique URL assigned to the organization by the SAML Identity Provider. | -| `logoutEnabled` | `boolean` | True if users are redirected to a URL after signing out of Sumo Logic. | -| `x509cert3` | `string` | The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Unique identifier of the SAML Identity Provider. | +| | `string` | The URL on Sumo Logic where the IdP will redirect to with its authentication response. | +| | `string` | The URL that the identity provider has assigned for Sumo Logic to submit SAML authentication requests to the identity provider. | +| | `string` | Authentication Request Signing Certificate for the user. | +| | `string` | Name of the SSO policy or another name used to describe the policy internally. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | True if additional details are included when a user fails to sign in. | +| | `boolean` | True if Sumo Logic will include the RequestedAuthnContext element of the SAML AuthnRequests it sends to the identity provider. | +| | `string` | The email address of the new user account. | +| | `string` | A unique identifier that is the intended audience of the SAML assertion. | +| | `boolean` | True if the SAML binding is of HTTP Redirect type. | +| | `string` | The unique URL assigned to the organization by the SAML Identity Provider. | +| | `boolean` | True if users are redirected to a URL after signing out of Sumo Logic. | +| | `string` | The URL that users will be redirected to after signing out of Sumo Logic. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `object` | | +| | `string` | The role that Sumo Logic will assign to users when they sign in. | +| | `boolean` | True if Sumo Logic will send signed Authn requests to the identity provider. | +| | `boolean` | True if Sumo Logic redirects users to your identity provider with a SAML AuthnRequest when signing in. | +| | `string` | This property has been deprecated and is no longer used. | +| | `string` | The certificate is used to verify the signature in SAML assertions. | +| | `string` | The backup certificate used to verify the signature in SAML assertions when x509cert1 expires. | +| | `string` | The backup certificate used to verify the signature in SAML assertions when x509cert1 expires and x509cert2 is empty. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getIdentityProviders` | `SELECT` | `region` | Get a list of all SAML configurations in the organization. | -| `createIdentityProvider` | `INSERT` | `data__configurationName, data__issuer, data__x509cert1, region` | Create a new SAML configuration in the organization. | -| `deleteIdentityProvider` | `DELETE` | `id, region` | Delete a SAML configuration with the given identifier from the organization. | -| `updateIdentityProvider` | `EXEC` | `id, data__configurationName, data__issuer, data__x509cert1, region` | Update an existing SAML configuration in the organization. | +| | `SELECT` | | Get a list of all SAML configurations in the organization. | +| | `INSERT` | | Create a new SAML configuration in the organization. | +| | `DELETE` | | Delete a SAML configuration with the given identifier from the organization. | +| | `EXEC` | | Update an existing SAML configuration in the organization. | diff --git a/docs/sumologic-docs/providers/sumologic/saml/index.md b/docs/sumologic-docs/providers/sumologic/saml/index.md index 591d147b42..8ebff9ff0c 100644 --- a/docs/sumologic-docs/providers/sumologic/saml/index.md +++ b/docs/sumologic-docs/providers/sumologic/saml/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + saml :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/saml/lockdown_disable/index.md b/docs/sumologic-docs/providers/sumologic/saml/lockdown_disable/index.md index d0a3bdb77d..f17da94e4f 100644 --- a/docs/sumologic-docs/providers/sumologic/saml/lockdown_disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/saml/lockdown_disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelockdown_disable
TypeResource
Idsumologic.saml.lockdown_disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableSamlLockdown` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/saml/lockdown_enable/index.md b/docs/sumologic-docs/providers/sumologic/saml/lockdown_enable/index.md index 07993e3e54..c4808c2d24 100644 --- a/docs/sumologic-docs/providers/sumologic/saml/lockdown_enable/index.md +++ b/docs/sumologic-docs/providers/sumologic/saml/lockdown_enable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelockdown_enable
TypeResource
Idsumologic.saml.lockdown_enable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enableSamlLockdown` | `EXEC` | `region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/scheduled_views/disable/index.md b/docs/sumologic-docs/providers/sumologic/scheduled_views/disable/index.md index 0365a230d8..02b9cb730a 100644 --- a/docs/sumologic-docs/providers/sumologic/scheduled_views/disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/scheduled_views/disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedisable
TypeResource
Idsumologic.scheduled_views.disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableScheduledView` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/scheduled_views/index.md b/docs/sumologic-docs/providers/sumologic/scheduled_views/index.md index 35e1940e43..a74b17c404 100644 --- a/docs/sumologic-docs/providers/sumologic/scheduled_views/index.md +++ b/docs/sumologic-docs/providers/sumologic/scheduled_views/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + scheduledViews :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/scheduled_views/pause/index.md b/docs/sumologic-docs/providers/sumologic/scheduled_views/pause/index.md index c8407d0724..3fa4bf8bd3 100644 --- a/docs/sumologic-docs/providers/sumologic/scheduled_views/pause/index.md +++ b/docs/sumologic-docs/providers/sumologic/scheduled_views/pause/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepause
TypeResource
Idsumologic.scheduled_views.pause
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `pauseScheduledView` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/scheduled_views/scheduled_views/index.md b/docs/sumologic-docs/providers/sumologic/scheduled_views/scheduled_views/index.md index 2ccd4b50bb..1676206dbf 100644 --- a/docs/sumologic-docs/providers/sumologic/scheduled_views/scheduled_views/index.md +++ b/docs/sumologic-docs/providers/sumologic/scheduled_views/scheduled_views/index.md @@ -14,43 +14,46 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescheduled_views
TypeResource
Idsumologic.scheduled_views.scheduled_views
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier for the scheduled view. | -| `totalBytes` | `integer` | Total storage consumed by the scheduled view. | -| `parsingMode` | `string` | Define the parsing mode to scan the JSON format log messages. Possible values are:
1. `AutoParse`
2. `Manual`
In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011). | -| `error` | `string` | Errors related to the scheduled view. | -| `modifiedAt` | `string` | Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `indexName` | `string` | Name of the index for the scheduled view. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `createdAt` | `string` | Creation timestamp in UTC. | -| `retentionEffectiveAt` | `string` | When the newRetentionPeriod will become effective in UTC format. | -| `newRetentionPeriod` | `integer` | If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time. | -| `filledRanges` | `array` | List of the different units of filled ranges since the autoview has been created. | -| `status` | `string` | Status of the scheduled view. | -| `startTime` | `string` | Start timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `createdBy` | `string` | Identifier of the user who created the scheduled view. | -| `query` | `string` | The query that defines the data to be included in the scheduled view. | -| `indexId` | `string` | The `id` of the Index where the output from Scheduled view is stored. | -| `totalMessageCount` | `integer` | Total number of messages for the scheduled view. | -| `createdByOptimizeIt` | `boolean` | If the scheduled view is created by OptimizeIt. | -| `retentionPeriod` | `integer` | The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention enabled. | -| `dataForwardingId` | `string` | An optional ID of a data forwarding configuration to be used by the scheduled view. | +| | `string` | Identifier for the scheduled view. | +| | `string` | Creation timestamp in UTC. | +| | `string` | Identifier of the user who created the scheduled view. | +| | `boolean` | If the scheduled view is created by OptimizeIt. | +| | `string` | An optional ID of a data forwarding configuration to be used by the scheduled view. | +| | `string` | Errors related to the scheduled view. | +| | `array` | List of the different units of filled ranges since the autoview has been created. | +| | `string` | The `id` of the Index where the output from Scheduled view is stored. | +| | `string` | Name of the index for the scheduled view. | +| | `string` | Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who last modified the resource. | +| | `integer` | If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time. | +| | `string` | Define the parsing mode to scan the JSON format log messages. Possible values are:
1. `AutoParse`
2. `Manual`
In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011). | +| | `string` | The query that defines the data to be included in the scheduled view. | +| | `string` | When the newRetentionPeriod will become effective in UTC format. | +| | `integer` | The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention enabled. | +| | `string` | Start timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Status of the scheduled view. | +| | `integer` | Total storage consumed by the scheduled view. | +| | `integer` | Total number of messages for the scheduled view. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getScheduledView` | `SELECT` | `id, region` | Get a scheduled view with the given identifier. | -| `listScheduledViews` | `SELECT` | `region` | Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page. | -| `createScheduledView` | `INSERT` | `data__indexName, data__query, data__startTime, region` | Creates a new scheduled view in the organization. | -| `updateScheduledView` | `EXEC` | `id, region` | Update an existing scheduled view. | +| | `SELECT` | | Get a scheduled view with the given identifier. | +| | `SELECT` | | Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page. | +| | `INSERT` | | Creates a new scheduled view in the organization. | +| | `EXEC` | | Update an existing scheduled view. | diff --git a/docs/sumologic-docs/providers/sumologic/scheduled_views/start/index.md b/docs/sumologic-docs/providers/sumologic/scheduled_views/start/index.md index 074107c8de..0e8c0bd41c 100644 --- a/docs/sumologic-docs/providers/sumologic/scheduled_views/start/index.md +++ b/docs/sumologic-docs/providers/sumologic/scheduled_views/start/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestart
TypeResource
Idsumologic.scheduled_views.start
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `startScheduledView` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses/index.md index 92f6fceff6..aa97befa08 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaddresses
TypeResource
Idsumologic.service_allowlist.addresses
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `description` | `string` | Description of the CIDR notation or IP address. | -| `cidr` | `string` | The string representation of the CIDR notation or IP address. | +| | `string` | Description of the CIDR notation or IP address. | +| | `string` | The string representation of the CIDR notation or IP address. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `listAllowlistedCidrs` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_add/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_add/index.md index 613b34ca17..af7f843ece 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_add/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_add/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaddresses_add
TypeResource
Idsumologic.service_allowlist.addresses_add
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `addAllowlistedCidrs` | `INSERT` | `data__data, region` | +| | `INSERT` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_remove/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_remove/index.md index c35bdb5981..95a005bb73 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_remove/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/addresses_remove/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaddresses_remove
TypeResource
Idsumologic.service_allowlist.addresses_remove
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `deleteAllowlistedCidrs` | `EXEC` | `data__data, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/disable/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/disable/index.md index 32faa790c7..5e1cf73cd5 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedisable
TypeResource
Idsumologic.service_allowlist.disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableAllowlisting` | `EXEC` | `allowlistType, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/enable/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/enable/index.md index 9f85770a1a..d4943c0bcb 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/enable/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/enable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameenable
TypeResource
Idsumologic.service_allowlist.enable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enableAllowlisting` | `EXEC` | `allowlistType, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/index.md index 6641dfdc8f..04a3465f32 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + serviceAllowlist :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/service_allowlist/status/index.md b/docs/sumologic-docs/providers/sumologic/service_allowlist/status/index.md index 4e8613d2ae..d2a3ca5ab0 100644 --- a/docs/sumologic-docs/providers/sumologic/service_allowlist/status/index.md +++ b/docs/sumologic-docs/providers/sumologic/service_allowlist/status/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus
TypeResource
Idsumologic.service_allowlist.status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `loginEnabled` | `boolean` | Whether service allowlisting is enabled for Login. | -| `contentEnabled` | `boolean` | Whether service allowlisting is enabled for Content. | +| | `boolean` | Whether service allowlisting is enabled for Content. | +| | `boolean` | Whether service allowlisting is enabled for Login. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getAllowlistingStatus` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/copy/index.md b/docs/sumologic-docs/providers/sumologic/slos/copy/index.md index 87819e4e55..b534754051 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/copy/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/copy/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecopy
TypeResource
Idsumologic.slos.copy
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `slosCopy` | `EXEC` | `id, data__parentId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/export/index.md b/docs/sumologic-docs/providers/sumologic/slos/export/index.md index dba673cdc2..ac66fa3862 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/export/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/export/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameexport
TypeResource
Idsumologic.slos.export
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `slosExportItem` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/import/index.md b/docs/sumologic-docs/providers/sumologic/slos/import/index.md index 8da6a8f523..f534cdd19b 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/import/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/import/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimport
TypeResource
Idsumologic.slos.import
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `slosImportItem` | `EXEC` | `parentId, data__name, data__type, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/index.md b/docs/sumologic-docs/providers/sumologic/slos/index.md index 1a0471629a..ded48e22d9 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + slos :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/slos/move/index.md b/docs/sumologic-docs/providers/sumologic/slos/move/index.md index 2ac1f36474..15cb8db0ce 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/move/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/move/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemove
TypeResource
Idsumologic.slos.move
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `slosMove` | `EXEC` | `id, parentId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/path/index.md b/docs/sumologic-docs/providers/sumologic/slos/path/index.md index 4574313c65..446ff19206 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/path/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/path/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepath
TypeResource
Idsumologic.slos.path
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `path` | `string` | String representation of the path. | -| `pathItems` | `array` | Elements of the path. | +| | `string` | String representation of the path. | +| | `array` | Elements of the path. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSlosFullPath` | `SELECT` | `id, region` | Get the full path of the slo or folder in the slos library. | -| `slosGetByPath` | `EXEC` | `path, region` | Read a slo or folder by its path in the slos library structure. | +| | `SELECT` | | Get the full path of the slo or folder in the slos library. | +| | `EXEC` | | Read a slo or folder by its path in the slos library structure. | diff --git a/docs/sumologic-docs/providers/sumologic/slos/root/index.md b/docs/sumologic-docs/providers/sumologic/slos/root/index.md index 031b70583a..7dab6a889a 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/root/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/root/index.md @@ -14,36 +14,39 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroot
TypeResource
Idsumologic.slos.root
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the slo or folder. | -| `name` | `string` | Identifier of the slo or folder. | -| `description` | `string` | Description of the slo or folder. | -| `contentType` | `string` | Type of the content. Valid values:
1) Slo
2) Folder | -| `isMutable` | `boolean` | Immutable objects are "READ-ONLY". | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `parentId` | `string` | Identifier of the parent folder. | -| `children` | `array` | Children of the folder. NOTE: Permissions field will not be filled (empty list) for children. | -| `permissions` | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | -| `version` | `integer` | Version of the slo or folder. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `type` | `string` | Type of the object model. | -| `isSystem` | `boolean` | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `_permissions` | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | +| | `string` | Identifier of the slo or folder. | +| | `string` | Identifier of the slo or folder. | +| | `string` | Description of the slo or folder. | +| | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | +| | `array` | Children of the folder. NOTE: Permissions field will not be filled (empty list) for children. | +| | `string` | Type of the content. Valid values:
1) Slo
2) Folder | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | Immutable objects are "READ-ONLY". | +| | `boolean` | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Identifier of the parent folder. | +| | `array` | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. | +| | `string` | Type of the object model. | +| | `integer` | Version of the slo or folder. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSlosLibraryRoot` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/search/index.md b/docs/sumologic-docs/providers/sumologic/slos/search/index.md index 40be719e3f..973b021e8f 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/search/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/search/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesearch
TypeResource
Idsumologic.slos.search
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `slosSearch` | `EXEC` | `query, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/sli/index.md b/docs/sumologic-docs/providers/sumologic/slos/sli/index.md index e53cb79e0c..3a524006e3 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/sli/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/sli/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesli
TypeResource
Idsumologic.slos.sli
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `sli` | `EXEC` | `ids, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/slos/slos/index.md b/docs/sumologic-docs/providers/sumologic/slos/slos/index.md index 9e23e8e442..ce3ef1cb13 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/slos/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/slos/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameslos
TypeResource
Idsumologic.slos.slos
Id
## Fields @@ -29,9 +32,9 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `slosCreate` | `EXEC` | `parentId, data__name, data__type, region` | Create a slo or folder in the slos library. | -| `slosDeleteById` | `EXEC` | `id, region` | Delete a slo or folder from the slos library. | -| `slosDeleteByIds` | `EXEC` | `ids, region` | Bulk delete a slo or folder by the given identifiers in the slos library. | -| `slosReadById` | `EXEC` | `id, region` | Get a slo or folder from the slos library. | -| `slosReadByIds` | `EXEC` | `ids, region` | Bulk read a slo or folder by the given identifiers from the slos library. | -| `slosUpdateById` | `EXEC` | `id, data__name, data__type, data__version, region` | Update a slo or folder in the slos library. | +| | `EXEC` | | Create a slo or folder in the slos library. | +| | `EXEC` | | Delete a slo or folder from the slos library. | +| | `EXEC` | | Bulk delete a slo or folder by the given identifiers in the slos library. | +| | `EXEC` | | Get a slo or folder from the slos library. | +| | `EXEC` | | Bulk read a slo or folder by the given identifiers from the slos library. | +| | `EXEC` | | Update a slo or folder in the slos library. | diff --git a/docs/sumologic-docs/providers/sumologic/slos/usage_info/index.md b/docs/sumologic-docs/providers/sumologic/slos/usage_info/index.md index ff4477f961..b4ab09c2bd 100644 --- a/docs/sumologic-docs/providers/sumologic/slos/usage_info/index.md +++ b/docs/sumologic-docs/providers/sumologic/slos/usage_info/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_info
TypeResource
Idsumologic.slos.usage_info
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSloUsageInfo` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tokens/index.md b/docs/sumologic-docs/providers/sumologic/tokens/index.md index 9643761abe..c904bc6c0e 100644 --- a/docs/sumologic-docs/providers/sumologic/tokens/index.md +++ b/docs/sumologic-docs/providers/sumologic/tokens/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + tokens :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/tokens/tokens/index.md b/docs/sumologic-docs/providers/sumologic/tokens/tokens/index.md index 3de2fffb2b..45d89fc5b3 100644 --- a/docs/sumologic-docs/providers/sumologic/tokens/tokens/index.md +++ b/docs/sumologic-docs/providers/sumologic/tokens/tokens/index.md @@ -14,34 +14,37 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametokens
TypeResource
Idsumologic.tokens.tokens
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the token. | -| `name` | `string` | Name of the token. | -| `description` | `string` | Description of the token. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `status` | `string` | Status of the token. Can be `Active`, or `Inactive`. | -| `type` | `string` | Type of the token. Valid values: 1) CollectorRegistrationTokenResponse | -| `version` | `integer` | Version of the token. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the token. | +| | `string` | Name of the token. | +| | `string` | Description of the token. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `string` | Status of the token. Can be `Active`, or `Inactive`. | +| | `string` | Type of the token. Valid values: 1) CollectorRegistrationTokenResponse | +| | `integer` | Version of the token. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getToken` | `SELECT` | `id, region` | Get a token with the given identifier in the token library. | -| `listTokens` | `SELECT` | `region` | Get a list of all tokens in the token library. | -| `createToken` | `INSERT` | `data__name, data__status, data__type, region` | Create a token in the token library. | -| `deleteToken` | `DELETE` | `id, region` | Delete a token with the given identifier in the token library. | -| `updateToken` | `EXEC` | `id, data__name, data__status, data__type, data__version, region` | Update a token with the given identifier in the token library. | +| | `SELECT` | | Get a token with the given identifier in the token library. | +| | `SELECT` | | Get a list of all tokens in the token library. | +| | `INSERT` | | Create a token in the token library. | +| | `DELETE` | | Delete a token with the given identifier in the token library. | +| | `EXEC` | | Update a token with the given identifier in the token library. | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/index.md b/docs/sumologic-docs/providers/sumologic/tracing/index.md index bede89f3e2..21965151b0 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + tracing :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/tracing/metrics/index.md b/docs/sumologic-docs/providers/sumologic/tracing/metrics/index.md index cd29e841a0..9acf44ce1f 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/metrics/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/metrics/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics
TypeResource
Idsumologic.tracing.metrics
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getMetrics` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/service_map/index.md b/docs/sumologic-docs/providers/sumologic/tracing/service_map/index.md index 86ed646e43..9b738ef3f5 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/service_map/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/service_map/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_map
TypeResource
Idsumologic.tracing.service_map
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `edges` | `array` | List of service map edges. | -| `nodes` | `array` | List of service map nodes. | +| | `array` | List of service map edges. | +| | `array` | List of service map nodes. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getServiceMap` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery/index.md index 292a0c96ce..f1ca70a712 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery
TypeResource
Idsumologic.tracing.spanquery
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `createSpanQuery` | `INSERT` | `data__queryRows, data__timeRange, region` | Execute a span analytics query and get the id to fetch its status and results. Use the [Span Query Status](#operation/getSpanQueryStatus) endpoint to check a query status. When the query has been completed, use the [Span Query Result](#operation/getSpanQueryResult) endpoint to get the result of the asynchronous query. | -| `cancelSpanQuery` | `EXEC` | `queryId, region` | Cancel a currently processed span search query with the given id. | +| | `INSERT` | | Execute a span analytics query and get the id to fetch its status and results. Use the [Span Query Status](#operation/getSpanQueryStatus) endpoint to check a query status. When the query has been completed, use the [Span Query Result](#operation/getSpanQueryResult) endpoint to get the result of the asynchronous query. | +| | `EXEC` | | Cancel a currently processed span search query with the given id. | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_aggregates/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_aggregates/index.md index 1cb379db4c..c0cdc1acbf 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_aggregates/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_aggregates/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_aggregates
TypeResource
Idsumologic.tracing.spanquery_aggregates
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryAggregates` | `SELECT` | `queryId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields/index.md index 17415a9dce..bf0533a529 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_fields
TypeResource
Idsumologic.tracing.spanquery_fields
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryFields` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields_values/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields_values/index.md index c5c2e138ee..18a2d2b194 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields_values/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_fields_values/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_fields_values
TypeResource
Idsumologic.tracing.spanquery_fields_values
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `next` | `string` | Next continuation token. | -| `totalCount` | `integer` | Total number of values for a field matching the query. Can be approximated when it's above 3000. | -| `fieldValues` | `array` | List of filter field values. | +| | `array` | List of filter field values. | +| | `string` | Next continuation token. | +| | `integer` | Total number of values for a field matching the query. Can be approximated when it's above 3000. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryFieldValues` | `SELECT` | `field, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_pause/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_pause/index.md index 12125b2c6e..0ce759969e 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_pause/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_pause/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_pause
TypeResource
Idsumologic.tracing.spanquery_pause
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `pauseSpanQuery` | `EXEC` | `queryId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_resume/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_resume/index.md index 463517302c..6e5c43be56 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_resume/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_resume/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_resume
TypeResource
Idsumologic.tracing.spanquery_resume
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `resumeSpanQuery` | `EXEC` | `queryId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_facets/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_facets/index.md index bd16724678..48242245ef 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_facets/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_facets/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_rows_facets
TypeResource
Idsumologic.tracing.spanquery_rows_facets
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryFacets` | `SELECT` | `queryId, rowId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_spans/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_spans/index.md index 9199092b28..50263ced16 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_spans/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_rows_spans/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_rows_spans
TypeResource
Idsumologic.tracing.spanquery_rows_spans
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `spanPage` | `array` | List of trace spans. | -| `next` | `string` | Next continuation token. | +| | `string` | Next continuation token. | +| | `array` | List of trace spans. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryResult` | `SELECT` | `queryId, rowId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_status/index.md b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_status/index.md index 4a9b19fb61..1c3bca6f86 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/spanquery_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/spanquery_status/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespanquery_status
TypeResource
Idsumologic.tracing.spanquery_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `queryRows` | `array` | A list of span analytics queries. | -| `status` | `string` | Status of the query. Possible values: `Processing`, `Finished`, `Error`, `Paused` | +| | `array` | A list of span analytics queries. | +| | `string` | Status of the query. Possible values: `Processing`, `Finished`, `Error`, `Paused` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanQueryStatus` | `SELECT` | `queryId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/tracequery/index.md b/docs/sumologic-docs/providers/sumologic/tracing/tracequery/index.md index 89628bcf2e..8004ec3c7e 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/tracequery/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/tracequery/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametracequery
TypeResource
Idsumologic.tracing.tracequery
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `createTraceQuery` | `INSERT` | `data__queryRows, data__timeRange, region` | Execute a trace search query and get the id to fetch its status and results. Use the [Trace Query Status](#operation/getTraceQueryStatus) endpoint to check a query status. When the query has been completed, use the [Trace Query Result](#operation/getTraceQueryResult) endpoint to get the result of the asynchronous query. | -| `cancelTraceQuery` | `EXEC` | `queryId, region` | Cancel a currently processed trace search query with the given id. | +| | `INSERT` | | Execute a trace search query and get the id to fetch its status and results. Use the [Trace Query Status](#operation/getTraceQueryStatus) endpoint to check a query status. When the query has been completed, use the [Trace Query Result](#operation/getTraceQueryResult) endpoint to get the result of the asynchronous query. | +| | `EXEC` | | Cancel a currently processed trace search query with the given id. | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields/index.md b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields/index.md index ea8b3d48c4..90f2c77dea 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametracequery_fields
TypeResource
Idsumologic.tracing.tracequery_fields
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTraceQueryFields` | `SELECT` | `region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields_values/index.md b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields_values/index.md index bf4b5fd66a..b6618ad1c3 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields_values/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_fields_values/index.md @@ -14,23 +14,26 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametracequery_fields_values
TypeResource
Idsumologic.tracing.tracequery_fields_values
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fieldValues` | `array` | List of filter field values. | -| `next` | `string` | Next continuation token. | -| `totalCount` | `integer` | Total number of values for a field matching the query. Can be approximated when it's above 3000. | +| | `array` | List of filter field values. | +| | `string` | Next continuation token. | +| | `integer` | Total number of values for a field matching the query. Can be approximated when it's above 3000. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTraceQueryFieldValues` | `SELECT` | `field, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_rows_traces/index.md b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_rows_traces/index.md index 7ebaee80c9..da28d4fff5 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_rows_traces/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_rows_traces/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametracequery_rows_traces
TypeResource
Idsumologic.tracing.tracequery_rows_traces
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `next` | `string` | Next continuation token. | -| `results` | `array` | List of traces matching the query. | +| | `string` | Next continuation token. | +| | `array` | List of traces matching the query. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTraceQueryResult` | `SELECT` | `queryId, rowId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_status/index.md b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_status/index.md index 2287de4c26..14f7138476 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/tracequery_status/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/tracequery_status/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametracequery_status
TypeResource
Idsumologic.tracing.tracequery_status
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `queryRows` | `array` | A list of trace queries. | -| `status` | `string` | Status of the query. Possible values: `Processing`, `Finished`, `Error`, `Canceled`. | +| | `array` | A list of trace queries. | +| | `string` | Status of the query. Possible values: `Processing`, `Finished`, `Error`, `Canceled`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTraceQueryStatus` | `SELECT` | `queryId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces/index.md index 6c8f7177a3..5477f2a311 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces
TypeResource
Idsumologic.tracing.traces
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Trace identifier. | -| `rootOperationName` | `string` | The name of the operation given to the root span. | -| `rootResource` | `string` | Root resource on which the trace was started. Examples: `db.query`, `http.request`, `rpc.call`, `container` | -| `rootService` | `string` | Root service which started the trace. Examples: `user-service`, `authentication-service`, `payment-service`, `/shopping-cart` | -| `rootStatus` | `object` | | -| `startedAt` | `string` | Date and time the trace was started in [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `criticalPathServiceBreakdownSummary` | `object` | | -| `metrics` | `object` | Calculated trace metrics. | +| | `string` | Trace identifier. | +| | `object` | | +| | `object` | Calculated trace metrics. | +| | `string` | The name of the operation given to the root span. | +| | `string` | Root resource on which the trace was started. Examples: `db.query`, `http.request`, `rpc.call`, `container` | +| | `string` | Root service which started the trace. Examples: `user-service`, `authentication-service`, `payment-service`, `/shopping-cart` | +| | `object` | | +| | `string` | Date and time the trace was started in [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339) format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTrace` | `SELECT` | `traceId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path/index.md index 3f1754e5d1..de18eb096d 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_critical_path
TypeResource
Idsumologic.tracing.traces_critical_path
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `segments` | `array` | List of span segments from the critical path. | -| `next` | `string` | Next continuation token. | +| | `string` | Next continuation token. | +| | `array` | List of span segments from the critical path. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getCriticalPath` | `SELECT` | `traceId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path_breakdown_service/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path_breakdown_service/index.md index dcb308109f..5a2eb24b6d 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path_breakdown_service/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_critical_path_breakdown_service/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_critical_path_breakdown_service
TypeResource
Idsumologic.tracing.traces_critical_path_breakdown_service
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `idleTime` | `integer` | Overall time in nanoseconds when no particular operation was in progress. | -| `elements` | `array` | List of elements representing the critical path service breakdown. | +| | `array` | List of elements representing the critical path service breakdown. | +| | `integer` | Overall time in nanoseconds when no particular operation was in progress. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getCriticalPathServiceBreakdown` | `SELECT` | `traceId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_exists/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_exists/index.md index f8a96ad805..7497d8529a 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_exists/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_exists/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_exists
TypeResource
Idsumologic.tracing.traces_exists
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `traceExists` | `EXEC` | `traceId, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_spans/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_spans/index.md index 63adfb2d1d..22386c695b 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_spans/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_spans/index.md @@ -14,43 +14,46 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_spans
TypeResource
Idsumologic.tracing.traces_spans
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Identifier of the span. | -| `service` | `string` | The name of the service this span is part of. | -| `serviceColor` | `string` | Color hex code assigned to the service. | -| `remoteServiceColor` | `string` | Color hex code assigned to the remote service. | -| `criticalPathContribution` | `object` | | -| `serviceType` | `string` | Defines type of service. | -| `operationName` | `string` | The name of the operation given to the span. | -| `startedAt` | `string` | Date and time the span was started in the [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `parentId` | `string` | Identifier of the parent span, if any. If the span has no parent it's considered a root span. | -| `remoteServiceType` | `string` | Defines type of service. | -| `errorMessage` | `string` | Produced error message (could be a stack trace, database error code, ..) | -| `resource` | `string` | The name of the resource attached to the span. | -| `fields` | `object` | Fields attached to this span. | -| `events` | `array` | Events attached to this span. | -| `kind` | `string` | Span kind describes the relationship between the Span, its parents, and its children in a Trace. Possible values: `CLIENT`, `SERVER`, `PRODUCER`, `CONSUMER`, `INTERNAL`. | -| `status` | `object` | | -| `duration` | `integer` | Number of nanoseconds the span lasted. | -| `links` | `array` | List of casually related spans. | -| `remoteService` | `string` | Name of the possible remote span's service. | -| `logs` | `array` | Logs attached to this span. | -| `numberOfLinks` | `integer` | Number of span links in this span. | -| `info` | `object` | | +| | `string` | Identifier of the span. | +| | `object` | | +| | `integer` | Number of nanoseconds the span lasted. | +| | `string` | Produced error message (could be a stack trace, database error code, ..) | +| | `array` | Events attached to this span. | +| | `object` | Fields attached to this span. | +| | `object` | | +| | `string` | Span kind describes the relationship between the Span, its parents, and its children in a Trace. Possible values: `CLIENT`, `SERVER`, `PRODUCER`, `CONSUMER`, `INTERNAL`. | +| | `array` | List of casually related spans. | +| | `array` | Logs attached to this span. | +| | `integer` | Number of span links in this span. | +| | `string` | The name of the operation given to the span. | +| | `string` | Identifier of the parent span, if any. If the span has no parent it's considered a root span. | +| | `string` | Name of the possible remote span's service. | +| | `string` | Color hex code assigned to the remote service. | +| | `string` | Defines type of service. | +| | `string` | The name of the resource attached to the span. | +| | `string` | The name of the service this span is part of. | +| | `string` | Color hex code assigned to the service. | +| | `string` | Defines type of service. | +| | `string` | Date and time the span was started in the [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getSpan` | `SELECT` | `spanId, traceId, region` | Get details of a span with the given identifier. | -| `getSpans` | `SELECT` | `traceId, region` | Get a list of spans for the given trace. The response is paginated with a default limit of 100 spans per page. | +| | `SELECT` | | Get details of a span with the given identifier. | +| | `SELECT` | | Get a list of spans for the given trace. The response is paginated with a default limit of 100 spans per page. | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_spans_billing_info/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_spans_billing_info/index.md index aee71483e6..c44d0d11ff 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_spans_billing_info/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_spans_billing_info/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_spans_billing_info
TypeResource
Idsumologic.tracing.traces_spans_billing_info
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `billedFormat` | `string` | Billing format of the span. Number of bytes of this representation of the span is equal to `billedBytes`. | -| `billedBytes` | `integer` | Number of bytes that were charged for the span. | +| | `integer` | Number of bytes that were charged for the span. | +| | `string` | Billing format of the span. Number of bytes of this representation of the span is equal to `billedBytes`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getSpanBillingInfo` | `SELECT` | `spanId, traceId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/tracing/traces_trace_events/index.md b/docs/sumologic-docs/providers/sumologic/tracing/traces_trace_events/index.md index aff7a16e8b..c8b485ca01 100644 --- a/docs/sumologic-docs/providers/sumologic/tracing/traces_trace_events/index.md +++ b/docs/sumologic-docs/providers/sumologic/tracing/traces_trace_events/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametraces_trace_events
TypeResource
Idsumologic.tracing.traces_trace_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `spanEvents` | `object` | Map of span ids to lists of their events, without their attributes. | -| `next` | `string` | Next continuation token. | +| | `string` | Next continuation token. | +| | `object` | Map of span ids to lists of their events, without their attributes. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `getTraceLightEvents` | `SELECT` | `traceId, region` | +| | `SELECT` | | diff --git a/docs/sumologic-docs/providers/sumologic/transformation_rules/index.md b/docs/sumologic-docs/providers/sumologic/transformation_rules/index.md index e5caeb8584..9190fb9b19 100644 --- a/docs/sumologic-docs/providers/sumologic/transformation_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/transformation_rules/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + transformationRules :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/transformation_rules/transformation_rules/index.md b/docs/sumologic-docs/providers/sumologic/transformation_rules/transformation_rules/index.md index 2ea0d4fdcc..b385f292d6 100644 --- a/docs/sumologic-docs/providers/sumologic/transformation_rules/transformation_rules/index.md +++ b/docs/sumologic-docs/providers/sumologic/transformation_rules/transformation_rules/index.md @@ -14,31 +14,34 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametransformation_rules
TypeResource
Idsumologic.transformation_rules.transformation_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the transformation rule. | -| `enabled` | `boolean` | True if the rule is enabled. | -| `ruleDefinition` | `object` | The properties that define a transformation rule. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | +| | `string` | Unique identifier for the transformation rule. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `boolean` | True if the rule is enabled. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `object` | The properties that define a transformation rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getTransformationRule` | `SELECT` | `id, region` | Get a transformation rule with the given identifier. | -| `getTransformationRules` | `SELECT` | `region` | Get a list of transformation rules in the organization. The response is paginated with a default limit of 100 rules per page. | -| `createRule` | `INSERT` | `data__enabled, data__ruleDefinition, region` | Create a new transformation rule. | -| `deleteRule` | `DELETE` | `id, region` | Delete a transformation rule with the given identifier. | -| `updateTransformationRule` | `EXEC` | `id, data__enabled, data__ruleDefinition, region` | Update an existing transformation rule. All properties specified in the request are replaced. Missing properties will remain the same. | +| | `SELECT` | | Get a transformation rule with the given identifier. | +| | `SELECT` | | Get a list of transformation rules in the organization. The response is paginated with a default limit of 100 rules per page. | +| | `INSERT` | | Create a new transformation rule. | +| | `DELETE` | | Delete a transformation rule with the given identifier. | +| | `EXEC` | | Update an existing transformation rule. All properties specified in the request are replaced. Missing properties will remain the same. | diff --git a/docs/sumologic-docs/providers/sumologic/users/email_request_change/index.md b/docs/sumologic-docs/providers/sumologic/users/email_request_change/index.md index 71b61ecdad..c047845c6e 100644 --- a/docs/sumologic-docs/providers/sumologic/users/email_request_change/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/email_request_change/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameemail_request_change
TypeResource
Idsumologic.users.email_request_change
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `requestChangeEmail` | `EXEC` | `id, data__email, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/users/index.md b/docs/sumologic-docs/providers/sumologic/users/index.md index bafb2b8a32..1dfc6536c5 100644 --- a/docs/sumologic-docs/providers/sumologic/users/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- + users :::info Service Summary diff --git a/docs/sumologic-docs/providers/sumologic/users/mfa_disable/index.md b/docs/sumologic-docs/providers/sumologic/users/mfa_disable/index.md index 6e0f04a119..4c1204548d 100644 --- a/docs/sumologic-docs/providers/sumologic/users/mfa_disable/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/mfa_disable/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemfa_disable
TypeResource
Idsumologic.users.mfa_disable
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `disableMfa` | `EXEC` | `id, data__email, data__password, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/users/password_reset/index.md b/docs/sumologic-docs/providers/sumologic/users/password_reset/index.md index f979740b2e..d23f85b9cf 100644 --- a/docs/sumologic-docs/providers/sumologic/users/password_reset/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/password_reset/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepassword_reset
TypeResource
Idsumologic.users.password_reset
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `resetPassword` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/users/unlock/index.md b/docs/sumologic-docs/providers/sumologic/users/unlock/index.md index b755f79567..dd90c47596 100644 --- a/docs/sumologic-docs/providers/sumologic/users/unlock/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/unlock/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameunlock
TypeResource
Idsumologic.users.unlock
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `unlockUser` | `EXEC` | `id, region` | +| | `EXEC` | | diff --git a/docs/sumologic-docs/providers/sumologic/users/users/index.md b/docs/sumologic-docs/providers/sumologic/users/users/index.md index 32760a3297..8b30064e94 100644 --- a/docs/sumologic-docs/providers/sumologic/users/users/index.md +++ b/docs/sumologic-docs/providers/sumologic/users/users/index.md @@ -14,37 +14,40 @@ description: Query, deploy and manage Sumologic resources using SQL custom_edit_url: null image: /img/providers/sumologic/stackql-sumologic-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idsumologic.users.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the user. | -| `isActive` | `boolean` | True if the user is active. | -| `createdBy` | `string` | Identifier of the user who created the resource. | -| `modifiedBy` | `string` | Identifier of the user who last modified the resource. | -| `isMfaEnabled` | `boolean` | True if multi factor authentication is enabled for the user. | -| `roleIds` | `array` | List of roleIds associated with the user. | -| `createdAt` | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | -| `modifiedAt` | `string` | Last modification timestamp in UTC. | -| `lastLoginTimestamp` | `string` | Timestamp of the last login for the user in UTC. Will be null if the user has never logged in. | -| `lastName` | `string` | Last name of the user. | -| `firstName` | `string` | First name of the user. | -| `isLocked` | `boolean` | This has the value `true` if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons. | -| `email` | `string` | Email address of the user. | +| | `string` | Unique identifier for the user. | +| | `string` | Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format. | +| | `string` | Identifier of the user who created the resource. | +| | `string` | Email address of the user. | +| | `string` | First name of the user. | +| | `boolean` | True if the user is active. | +| | `boolean` | This has the value `true` if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons. | +| | `boolean` | True if multi factor authentication is enabled for the user. | +| | `string` | Timestamp of the last login for the user in UTC. Will be null if the user has never logged in. | +| | `string` | Last name of the user. | +| | `string` | Last modification timestamp in UTC. | +| | `string` | Identifier of the user who last modified the resource. | +| | `array` | List of roleIds associated with the user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getUser` | `SELECT` | `id, region` | Get a user with the given identifier from the organization. | -| `listUsers` | `SELECT` | `region` | Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page. | -| `createUser` | `INSERT` | `data__email, data__firstName, data__lastName, data__roleIds, region` | Create a new user in the organization. | -| `deleteUser` | `DELETE` | `id, region` | Delete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in "transferTo". | -| `updateUser` | `EXEC` | `id, data__firstName, data__isActive, data__lastName, data__roleIds, region` | Update an existing user in the organization. | +| | `SELECT` | | Get a user with the given identifier from the organization. | +| | `SELECT` | | Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page. | +| | `INSERT` | | Create a new user in the organization. | +| | `DELETE` | | Delete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in "transferTo". | +| | `EXEC` | | Update an existing user in the organization. | diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 850d2026cd..5ca1e044c8 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -240,7 +240,7 @@ 'linode': { 'custom': False, 'variables': """ -- `LINODE_TOKEN` - Linode API token (see [How to Create a Linode API Token](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/#create-an-api-token)) +- - Linode API token (see [How to Create a Linode API Token](https://www.linode.com/docs/products/tools/api/guides/manage-api-tokens/#create-an-api-token)) """, 'linux': """ AUTH='{ "linode": { "type": "bearer", "credentialsenvvar": "YOUR_LINODE_TOKEN_VAR" }}' @@ -257,7 +257,7 @@ 'digitalocean': { 'custom': False, 'variables': """ -- `DIGITALOCEAN_ACCESS_TOKEN` - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/)) +- - DigitalOcean API token (see [How to Create a Personal Access Token](https://docs.digitalocean.com/reference/api/create-personal-access-token/)) """, 'linux': """ AUTH='{ "digitalocean": { "type": "bearer", "credentialsenvvar": "YOUR_DIGITALOCEAN_TOKEN_VAR" }}' @@ -274,8 +274,8 @@ 'sumologic': { 'custom': False, 'variables': """ -- `SUMOLOGIC_ACCESSID` - SumoLogic Access ID (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) -- `SUMOLOGIC_ACCESSKEY` - SumoLogic Access Key (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) +- - SumoLogic Access ID (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) +- - SumoLogic Access Key (see [Generating an Access Key](https://help.sumologic.com/docs/manage/security/access-keys/)) """, 'linux': """ AUTH='{ "sumologic": { "type": "basic", "username_var": "YOUR_SUMOLOGIC_ACCESS_ID_VAR", "password_var": "YOUR_SUMOLOGIC_ACCESS_KEY_VAR" }}' @@ -310,7 +310,7 @@ 'netlify': { 'custom': False, 'variables': """ -- `NETLIFY_AUTH_TOKEN` - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) +- - Netlify API token (see [How to Create a Netlify API Token](https://docs.netlify.com/api/get-started/#authentication)) """, 'linux': """ AUTH='{ "netlify": { "type": "bearer", "credentialsenvvar": "YOUR_NETLIFY_AUTH_TOKEN_VAR" }}' @@ -346,7 +346,7 @@ 'okta': { 'custom': False, 'variables': """ -- `OKTA_API_TOKEN` - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) +- - Okta API Token (see [Creating an Okta API Token](https://developer.okta.com/docs/guides/create-an-api-token/)) """, 'linux': """ AUTH='{ "okta": { "type": "api_key", "valuePrefix": "SSWS ", "credentialsenvvar": "YOUR_OKTA_API_TOKEN_VAR" }}'