--- canonical_url: "https://docs.composio.dev/toolkits/linode" markdown_url: "https://docs.composio.dev/toolkits/linode.md" product: "platform" version: null last_updated: null --- # Linode Linode provides cloud infrastructure APIs for compute, networking, storage, Kubernetes, databases, DNS, and account operations. - **Category:** it operations - **Auth:** OAUTH2, API_KEY - **Composio-managed OAuth available?** No - **Tools:** 418 - **Triggers:** 0 - **Slug:** `LINODE` - **Version:** 00000000_00 ## Tools ### Acknowledge agreements **Slug:** `LINODE_ACKNOWLEDGE_AGREEMENTS` Acknowledge agreements. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `eu_model` | boolean | No | The acknowledgement status for the cross-border data transfer agreement. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `privacy_policy` | boolean | No | The acknowledgement status for Akamai's privacy statement. | | `billing_agreement` | boolean | No | Certain regions require that you share your tax identification number (TIN) with Akamai. When you do, you need to acknowledge Akamai's privacy statement agreement, in regards to its protection. When set to `true`, you've acknowledged this agreement. | | `master_service_agreement` | boolean | No | The acknowledgement status for Akamai's master service agreement. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a configuration profile interface **Slug:** `LINODE_ADD_A_CONFIGURATION_PROFILE_INTERFACE` Add a configuration profile interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a Linode interface **Slug:** `LINODE_ADD_A_LINODE_INTERFACE` Add a Linode interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | JSON request body matching the cited Linode operation schema. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a NAT Gateway IP address **Slug:** `LINODE_ADD_A_NAT_GATEWAY_IP_ADDRESS` Add a NAT Gateway IP address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | No | A public IPv4 address routed through this NAT Gateway. The address must be reserved on your account, not currently in use, and located in the same region as the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add images to a share group **Slug:** `LINODE_ADD_IMAGES_TO_A_SHARE_GROUP` Add images to a share group. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `images` | array | No | Linode request field `images`. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Allocate an IP address **Slug:** `LINODE_ALLOCATE_AN_IP_ADDRESS` Allocate an IP address. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Allocate an IPv4 address **Slug:** `LINODE_ALLOCATE_AN_IPV4_ADDRESS` Allocate an IPv4 address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The type of address you are allocating. Only IPv4 addresses may be allocated through this operation. | | `public` | boolean | Yes | Whether to create a public or private IPv4 address. | | `address` | string | No | An optional unassigned reserved IP address to be assigned to this Linode. If omitted, a new non-reserved IP address is allocated. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Allow CORS access to an Object Storage bucket (E0/E1) **Slug:** `LINODE_ALLOW_CORS_ACCESS_TO_AN_OBJECT_STORAGE_BUCKET_E0_E1` Allow CORS access to an Object Storage bucket (E0/E1). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `acl` | string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom") | No | The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL. | | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `cors_enabled` | boolean | No | Whether cross-origin resource sharing (CORS) is enabled for all origins in the bucket. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply a Linode's firewalls **Slug:** `LINODE_APPLY_A_LINODE_S_FIREWALLS` Apply a Linode's firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The ID of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign a placement group **Slug:** `LINODE_ASSIGN_A_PLACEMENT_GROUP` Assign a placement group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linodes` | array | No | The `linodeId` values for individual Linodes included in the placement group. | | `group_id` | integer | Yes | ID of the placement group to look up. Run the List placement groups operation and store the `id` for the applicable placement group. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign IP addresses **Slug:** `LINODE_ASSIGN_IP_ADDRESSES` Assign IP addresses. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region` | string | Yes | The ID of the region in which these assignments are to take place. All IPs and Linodes must exist in this region. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `assignments` | array | Yes | The list of assignments to make. You must have read_write access to all IPs being assigned and all Linodes being assigned to in order for the assignments to succeed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign IPv4s to Linodes **Slug:** `LINODE_ASSIGN_IPV4S_TO_LINODES` Assign IPv4s to Linodes. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region` | string | Yes | The ID of the region in which these assignments are to take place. All IPs and Linodes must exist in this region. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `assignments` | array | Yes | The list of assignments to make. You must have read_write access to all IPs being assigned and all Linodes being assigned to in order for the assignments to succeed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach a volume **Slug:** `LINODE_ATTACH_A_VOLUME` Attach a volume. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | No | The unique identifier assigned to the Linode configuration where you want to include this volume. Run the List configuration profiles operation and store the `id` for the target configuration. - The configuration needs to belong to the Linode referenced by `linode_id`. - If you don't include this value, the API uses the last booted configuration. | | `linode_id` | integer | Yes | The unique identifier assigned to the Linode where you want to attach the volume. Run the List Linodes operation and store the `id` for the target Linode. | | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `persist_across_boots` | boolean | No | If set to `false`, the volume won't be attached to the Linode configuration. In this case, more than eight volumes may be attached to a Linode if a Linode has 16GB of RAM or more. The number of volumes you can attach is equal to the number of GB of RAM that the Linode has, up to a maximum of 64. If you set this to `false`, you can't include a `config_id` and only the `linode_id` should be passed. To use this object, the target `linode_id` needs to have a status of `running`. Run the List Linodes operation to check the `status` of each Linode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Boot a Linode **Slug:** `LINODE_BOOT_A_LINODE` Boot a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | No | The Linode Config ID to boot into. | | `linode_id` | integer | Yes | The ID of the Linode to boot. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Boot a Linode into rescue mode **Slug:** `LINODE_BOOT_A_LINODE_INTO_RESCUE_MODE` Boot a Linode into rescue mode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `devices` | object | No | Linode request field `devices`. | | `linode_id` | integer | Yes | ID of the Linode to rescue. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel backups **Slug:** `LINODE_CANCEL_BACKUPS` Cancel backups. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The ID of the Linode to cancel backup service for. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Object Storage **Slug:** `LINODE_CANCEL_OBJECT_STORAGE` Cancel Object Storage. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone a disk **Slug:** `LINODE_CLONE_A_DISK` Clone a disk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `disk_id` | integer | Yes | ID of the Disk to clone. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone a domain **Slug:** `LINODE_CLONE_A_DOMAIN` Clone a domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string | Yes | __Filterable__ The new domain for the clone. Domain labels cannot be longer than 63 characters and must conform to RFC1035. Domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two Domains representing the same domain. | | `domain_id` | integer | Yes | ID of the Domain to clone. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone a Linode **Slug:** `LINODE_CLONE_A_LINODE` Clone a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `linode_id` | integer | Yes | ID of the Linode to clone. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone an alert definition **Slug:** `LINODE_CLONE_AN_ALERT_DEFINITION` Clone an alert definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `alert_id` | integer | Yes | The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone a volume **Slug:** `LINODE_CLONE_A_VOLUME` Clone a volume. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | Yes | The name of the new volume after the clone. A `label` can be up to 32 characters long and contain alphanumeric characters, hyphens, and underscores. This value is also used in the volume's `filesystem_path`. | | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Close a support ticket **Slug:** `LINODE_CLOSE_A_SUPPORT_TICKET` Close a support ticket. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ticket_id` | integer | Yes | The ID of the support ticket. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Configure IPv4 sharing **Slug:** `LINODE_CONFIGURE_IPV4_SHARING` Configure IPv4 sharing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ips` | array | Yes | A list of secondary Linode IPs to share with the primary Linode. - Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths) - Can include both private and public IPv4 addresses. - You must have access to all of these addresses and they must be in the same Region as the primary Linode. - Enter an empty array to remove all shared IP addresses. | | `linode_id` | integer | Yes | The ID of the primary Linode that the addresses will be shared with. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a configuration profile **Slug:** `LINODE_CREATE_A_CONFIGURATION_PROFILE` Create a configuration profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `linode_id` | integer | Yes | ID of the Linode to look up Configuration profiles for. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a domain **Slug:** `LINODE_CREATE_A_DOMAIN` Create a domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a domain record **Slug:** `LINODE_CREATE_A_DOMAIN_RECORD` Create a domain record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `domain_id` | integer | Yes | The ID of the Domain we are accessing Records for. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a firewall **Slug:** `LINODE_CREATE_A_FIREWALL` Create a firewall. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a firewall device **Slug:** `LINODE_CREATE_A_FIREWALL_DEVICE` Create a firewall device. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Kubernetes cluster **Slug:** `LINODE_CREATE_A_KUBERNETES_CLUSTER` Create a Kubernetes cluster. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. | | `tier` | string ("standard" | "enterprise") | No | __Beta__, __Filterable__ The desired Kubernetes tier, either `standard` or `enterprise`. 🚧 This field is available as part of the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`. | | `label` | string | No | __Filterable__ 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 | No | __Filterable__ This Kubernetes cluster's location. | | `vpc_id` | integer | No | __Beta__, __LKE Enterprise__ The ID of the VPC to use for the Kubernetes cluster. An appropriately sized subnet is auto-allocated. To specify an existing subnet, use `subnet_id` instead. If `subnet_id` and `vpc_id` are both unspecified, a new VPC and subnet are auto-allocated for the cluster. 🚧 This field is available as part of the beta API and can only be used by accounts with access to LKE Enterprise. Call the URL with the `apiVersion` path parameter set to `v4beta`. | | `subnet_id` | integer | No | __Beta__, __LKE Enterprise__ The ID of the VPC subnet to use for the Kubernetes cluster. This subnet must have both IPv4 and IPv6 enabled (dual-stack) and can't already be used on an existing cluster. With this field specified, the cluster deploys to the given subnet and its corresponding VPC. To specify a VPC and have a subnet auto-allocated, use `vpc_id` instead. If `subnet_id` and `vpc_id` are both unspecified, a new VPC and subnet are auto-allocated for the cluster. 🚧 Multiple clusters can't share the same subnet. This field is available as part of the beta API and can only be used by accounts with access to LKE Enterprise. Call the URL with the `apiVersion` path parameter set to `v4beta`. | | `node_pools` | array | No | The node pools to create for this Kubernetes cluster. Each node pool is a group of nodes (Linodes) with the same configuration. | | `stack_type` | string ("ipv4" | "ipv4-ipv6") | No | __Beta__, __LKE Enterprise__ The networking stack type of the Kubernetes cluster, either `ipv4` or `ipv4-ipv6`. This specifies that the cluster is IPv4 only (default) or supports both IPv4 and IPv6 (dual-stack). 🚧 This field is available as part of the beta API and can only be used by accounts with access to LKE Enterprise. Call the URL with the `apiVersion` path parameter set to `v4beta`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `apl_enabled` | boolean | No | __Write-once__ Whether to install the Akamai App Platform during creation of the LKE cluster. You can only set this when creating a new cluster, not when modifying existing clusters. | | `k8s_version` | string | No | __Filterable__ The desired Kubernetes version for this Kubernetes cluster in the format of `.`. The latest supported patch version is deployed. | | `control_plane` | object | No | Defines settings for the Kubernetes control plane, including High Availability (HA) and an IP-based Access Control List (ACL) for the control plane components. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a managed contact **Slug:** `LINODE_CREATE_A_MANAGED_CONTACT` Create a managed contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of this Contact. | | `email` | string | No | The address to email this Contact to alert them of issues. | | `group` | string | No | __Filterable__ A grouping for this Contact. This is for display purposes only. | | `phone` | object | No | Information about how to reach this Contact by phone. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a managed service **Slug:** `LINODE_CREATE_A_MANAGED_SERVICE` Create a managed service. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an alert definition **Slug:** `LINODE_CREATE_AN_ALERT_DEFINITION` Create an alert definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a NAT Gateway **Slug:** `LINODE_CREATE_A_NAT_GATEWAY` Create a NAT Gateway. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an email alert channel **Slug:** `LINODE_CREATE_AN_EMAIL_ALERT_CHANNEL` Create an email-only Monitor alert channel; webhook credentials are not accepted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The name of the notification channel for identification purposes. This value needs to be unique for each notification channel. | | `details` | object | Yes | Configuration settings for an `email` notification channel. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `channel_type` | string | Yes | Create an email notification channel. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an empty disk **Slug:** `LINODE_CREATE_AN_EMPTY_DISK` Create an empty disk without deploying an image or login credentials. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | integer | Yes | __Filterable__ The size of the disk in MB. Images require a minimum size. Run the Get an image operation to view its size. | | `label` | string | Yes | __Filterable__ The name of the disk. This is for display purposes only. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an empty Linode **Slug:** `LINODE_CREATE_AN_EMPTY_LINODE` Create a billable empty offline Linode without an image, disks, or login access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ Tags to help you organize your content. | | `type` | string | Yes | The Linode type of the Linode you're creating. | | `label` | string | No | __Filterable__ Provides a name for the Linode. If not provided, the API generates one for it. A Linode `label` has some constraints: - It needs to begin and end with an alphanumeric character. - It can only consist of alphanumeric characters, hyphens (`-`), underscores (`_`), or periods (`.`). - It can't contain two consecutive hyphens (`--`), underscores (`__`) or periods (`..`). | | `region` | string | Yes | The region where the Linode will be located. | | `private_ip` | boolean | No | If `true`, the created Linode will have private networking enabled and assigned a private IPv4 address. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | No | The firewall to attach this Linode to upon creation. This `firewall_id` field is for Linodes using VLAN and legacy configuration profile interfaces only. Setting `firewall_id` to `-1` indicates that no firewall device will be attached. If the `firewall_id` is not provided or is set to `null`, the default firewall assigned to this Linode will be used, if available. | | `placement_group` | object | No | Include this to assign this Linode to an existing placement group. These constraints apply: - The target placement group needs to be in the same `region` set for this Linode. - The placement group needs to have capacity. Run the Get a region operation and note either the `maximum_linodes_per_pg` (strict) or `maximum_linodes_per_flexible_pg` (flexible), based on your selected `placement_group_policy`. These represent the Linode limit per placement group, for each `placement_group_policy` type. You can then run the Get a placement group operation to review the Linodes in that group. | | `interface_generation` | string ("legacy_config" | "linode") | No | Interface type: legacy_config or linode. Omit it to use the account's interfaces_for_new_linodes default. Accounts configured as linode_only accept linode or omission; legacy_config_only accounts accept legacy_config or omission. On accounts that allow both, explicitly select the non-default type when needed. Once set to linode, this Linode can no longer use legacy configuration interfaces. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an image **Slug:** `LINODE_CREATE_AN_IMAGE` Create an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Tags used for organizational purposes. A tag can be from 3 to 100 characters long, and an image can have a maximum of 500 total tags. | | `label` | string | No | The short title for this image. If not provided, the disk's current label is used. | | `disk_id` | integer | No | The ID of the target Linode disk for this image. | | `cloud_init` | boolean | No | Whether this image supports cloud-init. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A detailed description of this image. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an IPv6 range **Slug:** `LINODE_CREATE_AN_IPV6_RANGE` Create an IPv6 range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | No | The ID of the Linode to assign this range to. The SLAAC address for the provided Linode is used as the range's `route_target`. - __Required__ if `route_target` is omitted from the request. - Mutually exclusive with `route_target`. Submitting values for both properties in a request results in an error. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `route_target` | string | No | The IPv6 SLAAC address to assign this range to. - __Required__ if `linode_id` is omitted from the request. - Mutually exclusive with `linode_id`. Submitting values for both properties in a request results in an error. You need to omit the `/128` prefix length of the SLAAC address when using this property. | | `prefix_length` | integer ("56" | "64") | Yes | The prefix length of the IPv6 range, either `56` or `64`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an Object Storage bucket **Slug:** `LINODE_CREATE_AN_OBJECT_STORAGE_BUCKET` Create an Object Storage bucket. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `acl` | string ("private" | "public-read" | "authenticated-read" | "public-read-write") | No | The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL. | | `label` | string | No | The name for this bucket. * A bucket name can contain from 3 to 63 alphanumeric characters, dashes (`-`), or dots (`.`). * A bucket name can't end in a dash and you can't use two consecutive dashes. * A bucket name can't start or end in a dot, and you can't use two consecutive dots. As a best practice, only use dots if a certificate you're using with your bucket requires it. (For example, if you're using a custom TLS certificate.) * A bucket name needs to be unique in the `region` where you're creating the bucket. The API only reserves labels for the `region` where active buckets are created and stored. If you want to reserve this bucket's label in another `region`, create a new bucket with the same label in the new `region`. | | `region` | string | No | The `id` assigned to the data center (region) where this Object Storage bucket should be created. This supports legacy `clusterId` values that represented a specific region. For example, `us-east-1` is the legacy reference for the `us-east` region. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `s3_endpoint` | string | No | The active user's S3-compatible endpoint URL, based on the `endpoint_type` and `region`. | | `cors_enabled` | boolean | No | Whether cross-origin resource sharing (CORS) is enabled for all origins in the bucket. CORS is only supported for legacy, E0 and E1 endpoint types. | | `endpoint_type` | string ("E0" | "E1" | "E2" | "E3") | No | The type of `s3_endpoint` available to the active `user` in this `region`. See Endpoint types for more information. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a node **Slug:** `LINODE_CREATE_A_NODE` Create a node. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `config_id` | integer | Yes | The ID of the NodeBalancer config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a NodeBalancer **Slug:** `LINODE_CREATE_A_NODEBALANCER` Create a billable NodeBalancer without a listening configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ipv4` | string | No | To ensure your NodeBalancer maintains a consistent public address, you can specify an unassigned reserved IP from your account during creation. If this field is omitted, the NodeBalancer is assigned a standard ephemeral IP by default. | | `tags` | array | No | An array of Tags applied to this object. Tags are for organizational purposes only. | | `type` | string ("common" | "premium") | No | The type of NodeBalancer. | | `vpcs` | array | No | You can have only one `vpcs` in a NodeBalancer configuration. If your backend nodes are in a VPC, specify the VPC subnet and CIDR range. NodeBalancer routes traffic to backend VPC nodes through this subnet. The specified VPC subnet must exist within the same data center as the NodeBalancer, and the provided IP range must be contained within the subnet's CIDR block. All IP addresses within the specified range must be free and available for assignment. Once the NodeBalancer is created, its VPC can't be changed. Also, `backend_connectivity` must be set to `vpc`. | | `label` | string | No | __Filterable__ This NodeBalancer's label. These must be unique on your Account. | | `region` | string | Yes | The ID of the Region to create this NodeBalancer in. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | No | The ID of the Firewall to assign to the NodeBalancer. - A NodeBalancer can have only one Firewall assigned to it. - Firewalls control inbound network traffic to NodeBalancers. | | `backend_connectivity` | string ("legacy" | "ipv6" | "vpc") | No | How the NodeBalancer reaches backend nodes; this cannot change after creation. legacy uses private IPv4 in 192.168.255.0/24 and is unavailable for premium NodeBalancers. ipv6 uses public IPv6. vpc uses VPC IPv4 or public IPv6 and is required when vpcs is supplied. All backend node addresses must match this mode. If omitted, Linode infers the mode from nodes or vpcs; otherwise premium NodeBalancers default to ipv6. | | `client_conn_throttle` | integer | No | Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to `0` (zero) to disable throttling. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a NodeBalancer config **Slug:** `LINODE_CREATE_A_NODEBALANCER_CONFIG` Create a non-TLS TCP, HTTP, or UDP NodeBalancer config without inline nodes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `port` | integer | Yes | This is the port the NodeBalancer listens on for this configuration. Port numbers must be unique across TCP, HTTP, and HTTPS configurations on a single NodeBalancer. However, ports assigned to TCP, HTTP, or HTTPS configurations can also be reused for UDP configurations. For example, Port 80 can simultaneously serve a TCP and a UDP configuration on the same NodeBalancer, but it can't be shared by both a TCP and an HTTP configuration. Although certain ports are traditionally associated with specific protocols, this isn't strictly enforced, and you may configure your NodeBalancer however you find useful. | | `check` | string ("none" | "connection" | "http" | "http_body") | No | The type of check to perform against backends to ensure they are serving requests. The `check` 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. | | `protocol` | string ("tcp" | "http" | "udp") | Yes | The non-TLS protocol this configuration serves. | | `algorithm` | string ("roundrobin" | "leastconn" | "source") | No | The algorithm this NodeBalancer configuration uses to route traffic to backends. | | `check_body` | string | No | Use when the active health `check` type is `http_body`. 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. | | `check_path` | string | No | The URL path to check on each backend. Use when the active health `check` type is `http`. If the backend doesn't respond to this request, it's considered to be down. | | `stickiness` | string ("none" | "table" | "http_cookie") | No | 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. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `check_passive` | boolean | No | 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. | | `check_timeout` | integer | No | How long, in seconds, to wait for a check attempt before considering it failed. Must be less than `check_interval`. | | `check_attempts` | integer | No | How many times to attempt a check before considering a backend to be down. | | `check_interval` | integer | No | How often, in seconds, to check that backends are up and serving requests. Must be greater than `check_timeout`. | | `proxy_protocol` | string ("none" | "v1" | "v2") | No | Proxy protocol mode. v1 and v2 require the tcp protocol. | | `udp_check_port` | integer | No | UDP NodeBalancers use TCP and HTTP active health checks to ensure back-end nodes can receive traffic. You can specify the health check port that the backend node listens on, which may differ from the UDP port used to serve traffic. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a node pool **Slug:** `LINODE_CREATE_A_NODE_POOL` Create a node pool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a placement group **Slug:** `LINODE_CREATE_A_PLACEMENT_GROUP` Create a placement group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a PostgreSQL connection pool **Slug:** `LINODE_CREATE_A_POSTGRESQL_CONNECTION_POOL` Create a PostgreSQL connection pool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("session" | "statement" | "transaction") | Yes | Set the connection pooling mode based on the specification set by our partner, Aiven. Select from `transaction`, `session`, or `statement`. | | `size` | integer | Yes | The number of connections in the pool. This can't exceed the number of available connections for your service plan. | | `label` | string | Yes | The name of the connection pool. These points apply: - It needs to be unique in a database instance. - It can contain alphanumeric characters, underscores, or hyphens, and it can't start with hyphen. - It has a maximum length of 63 characters. - It can't be edited once the connection pool is created. | | `database` | string | No | The name of the PostgreSQL Managed Database where the connection pool is assigned. This is the **Database name** value from connection details. To learn how to get this value, see View connection details. | | `username` | string | Yes | The username of the client making the connection. The default of `null` reuses the inbound user. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a reply **Slug:** `LINODE_CREATE_A_REPLY` Create a reply. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ticket_id` | integer | Yes | The ID of the support ticket. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | Yes | The content of your reply. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a resource lock **Slug:** `LINODE_CREATE_A_RESOURCE_LOCK` Create a resource lock. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Rule Set **Slug:** `LINODE_CREATE_A_RULE_SET` Create a Rule Set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("inbound" | "outbound") | No | Indicates whether the Rule Set’s rules are for `inbound` or `outbound` traffic. This needs to match the `type` in the rule group in which it appears. | | `label` | string | No | __Filterable__ Unique, user-defined label for this Rule Set. This label helps you identify and describe your Rule Set. | | `rules` | array | No | The inbound or outbound access rules for the Rule Set. A Rule Set can have a total of 25 inbound and outbound rules. Multiple rules are applied in order. If two rules conflict, the first rule takes precedence. For example, if the first rule accepts inbound traffic from an address, and the second rule drops inbound traffic from the same address, the first rule applies, and inbound traffic from that address is accepted. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | Describes this Rule Set. For display purposes only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a share group **Slug:** `LINODE_CREATE_A_SHARE_GROUP` Create a share group. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The share group's descriptive name. | | `images` | array | No | A list of image's details, including the ID, label, and description. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A detailed description of this share group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a snapshot **Slug:** `LINODE_CREATE_A_SNAPSHOT` Create a snapshot. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | Yes | The label for the new snapshot. | | `linode_id` | integer | Yes | The ID of the Linode the backups belong to. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a StackScript **Slug:** `LINODE_CREATE_A_STACKSCRIPT` Create a StackScript. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a stream **Slug:** `LINODE_CREATE_A_STREAM` Create a stream. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("audit_logs" | "lke_audit_logs") | Yes | The type of stream. This can be `audit_logs` for logs consisting of all of the control plane operations for the services in your Linodes, or `lke_audit_logs` for log data for your Linode Kubernetes Engine (LKE) enterprise clusters. | | `label` | string | Yes | The name of the stream. This is used for display purposes in Akamai Cloud Manager. | | `status` | string ("active" | "inactive") | No | The availability status of the stream. This can be `active` or `inactive`. | | `details` | object | No | Additional details for the stream, based on the selected `type`. Currently, this only applies to streams with a `type` of `lke_audit_logs`. Leave this object out of requests that use a `type` of `audit_logs`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `destinations` | array | Yes | The unique identifier for the sync point that will receive logs data. Run the List destinations operation and store the `id` value for the applicable destination. Currently, you can only specify a single destination for a stream. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a support ticket attachment **Slug:** `LINODE_CREATE_A_SUPPORT_TICKET_ATTACHMENT` Create a support ticket attachment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | The local, absolute path to the file you want to attach to your support ticket. | | `ticket_id` | integer | Yes | The ID of the support ticket. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a tag **Slug:** `LINODE_CREATE_A_TAG` Create a tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The name of your tag. This is used for display purposes. | | `domains` | array | No | The `id` values for the domains where you want to apply the tag. You need `read_write` access to each domain. If you don't, the API won't create the tag and you'll receive an error. You can run the List domains operation to store the `id` for desired domains and to review any `tags` currently applied. | | `linodes` | array | No | The `id` values for the Linodes where you want to apply the tag. You need `read_write` access to each Linode. If you don't, the API won't create the tag and you'll receive an error. You can run the List Linodes operation to store the `id` for desired Linodes and to review any `tags` currently applied. | | `volumes` | array | No | The `id` values for the Linode volumes where you want to apply the tag. You need `read_write` access to each volume. If you don't, the API won't create the tag and you'll receive an error. You can run the List volumes operation to store the `id` for desired Linode volumes and to review any `tags` currently applied. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `nodebalancers` | array | No | The `id` values for the NodeBalancers where you want to apply the tag. You need `read_write` access to each NodeBalancer. If you don't, the API won't create the tag and you'll receive an error. You can run the List NodeBalancers operation to store the `id` for desired NodeBalancers and to review any `tags` currently applied. | | `reserved_ipv4_addresses` | array | No | The reserved IPv4 addresses where you want to apply the tag. Each IP must be reserved on your account before you can tag it. Run the Reserve a public IPv4 address operation to reserve one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a volume **Slug:** `LINODE_CREATE_A_VOLUME` Create a volume. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | integer | No | The initial size of this volume, in GB. Volumes can only be resized after the creation completes. | | `tags` | array | No | __Filterable__ Any tags applied to this object. Use tags to label and organize your cloud computing resources. | | `label` | string | Yes | The name of the volume. A `label` can be up to 32 characters long and contain alphanumeric characters, hyphens, and underscores. This value is also used in the volume's `filesystem_path`. | | `region` | string | No | The region where the API deploys the volume. This is only required if you didn't provide a `linode_id` for the volume. | | `config_id` | integer | No | When creating a volume attached to a Linode, this is the identifier of the Linode configuration profile (config) where the volume will live. Run the List configuration profiles operation and store the `id` for the applicable config. The following apply when adding a `config_id`: - The selected config needs to belong to the Linode referenced by `linode_id` in this request. - You can't provide a `config_id` if you don't also provide a `linode_id` in the request. - If you send a `linode_id` without a `config_id`, the API attaches the volume to that Linode's last used config, or to the only config in that Linode. If there isn't a config available for attachment, the API returns an error. | | `linode_id` | integer | No | The Linode this volume should be attached to after it's created. If not given, the volume will be created without an attachment. | | `encryption` | string ("enabled" | "disabled") | No | Sets the disk encryption status for a volume, either `enabled` or `disabled`. When you create a new volume, disk encryption is enabled by default. Full disk encryption ensures the data stored on a Block Storage volume drive is secure. It protects against unauthorized access by keeping the data encrypted if the volume drive is removed from the data center, decommissioned, or disposed of. The platform automatically manages the encryption and decryption process for you. You can use an encrypted volume the same way you use a non-encrypted volume. You can only set disk encryption status when creating a new Block Storage volume. After you create a volume, you can't change its encryption setting. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a VPC **Slug:** `LINODE_CREATE_A_VPC` Create a VPC. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a VPC subnet **Slug:** `LINODE_CREATE_A_VPC_SUBNET` Create a VPC subnet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or restore a MySQL Managed Database **Slug:** `LINODE_CREATE_OR_RESTORE_A_MYSQL_MANAGED_DATABASE` Create or restore a MySQL Managed Database. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or restore a PostgreSQL Managed Database **Slug:** `LINODE_CREATE_OR_RESTORE_A_POSTGRESQL_MANAGED_DATABASE` Create or restore a PostgreSQL Managed Database. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or restore a Valkey Managed Database **Slug:** `LINODE_CREATE_OR_RESTORE_A_VALKEY_MANAGED_DATABASE` Create or restore a Valkey Managed Database. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a configuration profile **Slug:** `LINODE_DELETE_A_CONFIGURATION_PROFILE` Delete a configuration profile. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a configuration profile interface **Slug:** `LINODE_DELETE_A_CONFIGURATION_PROFILE_INTERFACE` Delete a configuration profile interface. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode Configuration Profile Interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a disk **Slug:** `LINODE_DELETE_A_DISK` Delete a disk. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `disk_id` | integer | Yes | ID of the Disk to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a domain **Slug:** `LINODE_DELETE_A_DOMAIN` Delete a domain. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain_id` | integer | Yes | The ID of the Domain to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a domain record **Slug:** `LINODE_DELETE_A_DOMAIN_RECORD` Delete a domain record. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain_id` | integer | Yes | The ID of the Domain whose Record you are accessing. | | `record_id` | integer | Yes | The ID of the Record you are accessing. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a firewall **Slug:** `LINODE_DELETE_A_FIREWALL` Delete a firewall. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a firewall device **Slug:** `LINODE_DELETE_A_FIREWALL_DEVICE` Delete a firewall device. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `device_id` | integer | Yes | ID of the Firewall Device to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Kubernetes cluster **Slug:** `LINODE_DELETE_A_KUBERNETES_CLUSTER` Delete a Kubernetes cluster. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Linode **Slug:** `LINODE_DELETE_A_LINODE` Delete a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Linode interface **Slug:** `LINODE_DELETE_A_LINODE_INTERFACE` Delete a Linode interface. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a managed contact **Slug:** `LINODE_DELETE_A_MANAGED_CONTACT` Delete a managed contact. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | integer | Yes | The ID of the contact to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a managed service monitor **Slug:** `LINODE_DELETE_A_MANAGED_SERVICE_MONITOR` Delete a managed service monitor. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `service_id` | integer | Yes | The ID of the Managed Service to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a MySQL Managed Database **Slug:** `LINODE_DELETE_A_MYSQL_MANAGED_DATABASE` Delete a MySQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an alert definition **Slug:** `LINODE_DELETE_AN_ALERT_DEFINITION` Delete an alert definition. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `alert_id` | integer | Yes | The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a NAT Gateway **Slug:** `LINODE_DELETE_A_NAT_GATEWAY` Delete a NAT Gateway. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an image **Slug:** `LINODE_DELETE_AN_IMAGE` Delete an image. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `image_id` | string | Yes | The unique identifier assigned to the image after creation. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an IPv4 address **Slug:** `LINODE_DELETE_AN_IPV4_ADDRESS` Delete an IPv4 address. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | The IP address. | | `linode_id` | integer | Yes | The ID of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an IPv6 range **Slug:** `LINODE_DELETE_AN_IPV6_RANGE` Delete an IPv6 range. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `range` | string | Yes | The IPv6 range to access. Corresponds to the `range` property of objects returned from the List IPv6 ranges operation. You need to omit the prefix length of the IPv6 range. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a node **Slug:** `LINODE_DELETE_A_NODE` Delete a node. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `node_id` | string | Yes | The ID of the Node to access. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster containing the Node. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a NodeBalancer **Slug:** `LINODE_DELETE_A_NODEBALANCER` Delete a NodeBalancer. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a NodeBalancer config **Slug:** `LINODE_DELETE_A_NODEBALANCER_CONFIG` Permanently delete a NodeBalancer config. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The ID of the Config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a NodeBalancer's node **Slug:** `LINODE_DELETE_A_NODEBALANCER_S_NODE` Delete a NodeBalancer's node. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `node_id` | string | Yes | The ID of the Node to access. | | `config_id` | integer | Yes | The ID of the Config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a node pool **Slug:** `LINODE_DELETE_A_NODE_POOL` Delete a node pool. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pool_id` | integer | Yes | ID of the Pool to look up. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a notification channel **Slug:** `LINODE_DELETE_A_NOTIFICATION_CHANNEL` Delete a notification channel. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `channel_id` | integer | Yes | The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a placement group **Slug:** `LINODE_DELETE_A_PLACEMENT_GROUP` Delete a placement group. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | ID of the placement group to look up. Run the List placement groups operation and store the `id` for the applicable placement group. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a PostgreSQL connection pool **Slug:** `LINODE_DELETE_A_POSTGRESQL_CONNECTION_POOL` Delete a PostgreSQL connection pool. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pool_name` | string | Yes | The `label` set for a specific connection pool in a PostgreSQL Managed Database. Run the List PostgreSQL connection pools operation and store the `label` for the desired one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a PostgreSQL Managed Database **Slug:** `LINODE_DELETE_A_POSTGRESQL_MANAGED_DATABASE` Delete a PostgreSQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a resource lock **Slug:** `LINODE_DELETE_A_RESOURCE_LOCK` Delete a resource lock. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | | `resource_lock_id` | integer | Yes | The unique identifier assigned to the resource lock. Run the List resource locks operation and store the `id` for the applicable resource lock. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Rule Set **Slug:** `LINODE_DELETE_A_RULE_SET` Delete a Rule Set. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `rule_set_id` | integer | Yes | ID of the Rule Set to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a share group **Slug:** `LINODE_DELETE_A_SHARE_GROUP` Delete a share group. This operation is available only through Linode API v4beta. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a StackScript **Slug:** `LINODE_DELETE_A_STACKSCRIPT` Delete a StackScript. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `stackscript_id` | string | Yes | The ID of the StackScript to look up. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a stream **Slug:** `LINODE_DELETE_A_STREAM` Delete a stream. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `stream_id` | integer | Yes | The unique identifier assigned to the stream. Run the List streams operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a tag **Slug:** `LINODE_DELETE_A_TAG` Delete a tag. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_label` | string | Yes | The `label` of the tag to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Valkey Managed Database **Slug:** `LINODE_DELETE_A_VALKEY_MANAGED_DATABASE` Delete a Valkey Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a VLAN **Slug:** `LINODE_DELETE_A_VLAN` Delete a VLAN. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | Yes | The label of the VLAN to be deleted. | | `region_id` | string | Yes | The VLAN's region. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a volume **Slug:** `LINODE_DELETE_A_VOLUME` Delete a volume. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a VPC **Slug:** `LINODE_DELETE_A_VPC` Delete a VPC. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a VPC subnet **Slug:** `LINODE_DELETE_A_VPC_SUBNET` Delete a VPC subnet. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `vpc_subnet_id` | integer | Yes | The `id` of the VPC Subnet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete the control plane access control list **Slug:** `LINODE_DELETE_THE_CONTROL_PLANE_ACCESS_CONTROL_LIST` Delete the control plane access control list. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Detach a volume **Slug:** `LINODE_DETACH_A_VOLUME` Detach a volume. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable a managed service monitor **Slug:** `LINODE_DISABLE_A_MANAGED_SERVICE_MONITOR` Disable a managed service monitor. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `service_id` | integer | Yes | The ID of the Managed Service to disable. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable a managed service monitor **Slug:** `LINODE_ENABLE_A_MANAGED_SERVICE_MONITOR` Enable a managed service monitor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `service_id` | integer | Yes | The ID of the Managed Service to enable. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable backups **Slug:** `LINODE_ENABLE_BACKUPS` Enable backups. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The ID of the Linode to enable backup service for. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable Linode Managed **Slug:** `LINODE_ENABLE_LINODE_MANAGED` Enable Linode Managed. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enroll in a Beta program **Slug:** `LINODE_ENROLL_IN_A_BETA_PROGRAM` Enroll in a Beta program. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier for the Beta program. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a backup **Slug:** `LINODE_GET_A_BACKUP` Get a backup. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `backup_id` | integer | Yes | The ID of the Backup to look up. | | `linode_id` | integer | Yes | The ID of the Linode the Backup belongs to. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Beta program **Slug:** `LINODE_GET_A_BETA_PROGRAM` Get a Beta program. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `beta_id` | string | Yes | The unique identifier for the Beta program. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a bucket's TLS/SSL certificate **Slug:** `LINODE_GET_A_BUCKET_S_TLS_SSL_CERTIFICATE` Get a bucket's TLS/SSL certificate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account Summary **Slug:** `LINODE_GET_ACCOUNT_SUMMARY` Return billing status, current balance, promotions, and enabled cloud capabilities for the connected Linode account, excluding contact and payment-card details. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a child account **Slug:** `LINODE_GET_A_CHILD_ACCOUNT` Get a child account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `euuid` | string | Yes | A unique identifier for a child account. To get this value, run List child accounts. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a config **Slug:** `LINODE_GET_A_CONFIG` Get a config. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The ID of the Config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a configuration profile **Slug:** `LINODE_GET_A_CONFIGURATION_PROFILE` Get a configuration profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a configuration profile interface **Slug:** `LINODE_GET_A_CONFIGURATION_PROFILE_INTERFACE` Get a configuration profile interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode Configuration Profile Interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a dashboard **Slug:** `LINODE_GET_A_DASHBOARD` Get a dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `dashboard_id` | integer | Yes | The unique identifier of the dashboard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a disk **Slug:** `LINODE_GET_A_DISK` Get a disk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `disk_id` | integer | Yes | ID of the Disk to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a domain **Slug:** `LINODE_GET_A_DOMAIN` Get a domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain_id` | integer | Yes | The ID of the Domain to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a domain record **Slug:** `LINODE_GET_A_DOMAIN_RECORD` Get a domain record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain_id` | integer | Yes | The ID of the Domain whose Record you are accessing. | | `record_id` | integer | Yes | The ID of the Record you are accessing. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a domain zone file **Slug:** `LINODE_GET_A_DOMAIN_ZONE_FILE` Get a domain zone file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain_id` | string | Yes | ID of the Domain. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a firewall **Slug:** `LINODE_GET_A_FIREWALL` Get a firewall. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a firewall device **Slug:** `LINODE_GET_A_FIREWALL_DEVICE` Get a firewall device. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `device_id` | integer | Yes | ID of the Firewall Device to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a firewall rule version **Slug:** `LINODE_GET_A_FIREWALL_RULE_VERSION` Get a firewall rule version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version` | integer | Yes | The firewall rule version to view. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a firewall template **Slug:** `LINODE_GET_A_FIREWALL_TEMPLATE` Get a firewall template. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slug` | string ("vpc" | "public") | Yes | __Enum__ The firewall template type, available for either `vpc` or `public` interfaces. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a kernel **Slug:** `LINODE_GET_A_KERNEL` Get a kernel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kernel_id` | string | Yes | ID of the Kernel to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Kubernetes cluster **Slug:** `LINODE_GET_A_KUBERNETES_CLUSTER` Get a Kubernetes cluster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Linode **Slug:** `LINODE_GET_A_LINODE` Get a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Linode interface **Slug:** `LINODE_GET_A_LINODE_INTERFACE` Get a Linode interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Linode's IP address **Slug:** `LINODE_GET_A_LINODE_S_IP_ADDRESS` Get a Linode's IP address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | The IP address. | | `linode_id` | integer | Yes | The ID of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Linode's managed settings **Slug:** `LINODE_GET_A_LINODE_S_MANAGED_SETTINGS` Get a Linode's managed settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The Linode ID whose settings we are accessing. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Longview plan **Slug:** `LINODE_GET_A_LONGVIEW_PLAN` Get a Longview plan. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Longview subscription **Slug:** `LINODE_GET_A_LONGVIEW_SUBSCRIPTION` Get a Longview subscription. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `subscription_id` | string ("longview-3" | "longview-10" | "longview-40" | "longview-100") | Yes | __Enum__ The Longview Subscription to look up. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a managed contact **Slug:** `LINODE_GET_A_MANAGED_CONTACT` Get a managed contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contact_id` | integer | Yes | The ID of the contact to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Managed Databases engine **Slug:** `LINODE_GET_A_MANAGED_DATABASES_ENGINE` Get a Managed Databases engine. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `engine_id` | string | Yes | The ID of the Managed Database engine. To get this value, run the List Managed Databases engines operation. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Managed Databases type **Slug:** `LINODE_GET_A_MANAGED_DATABASES_TYPE` Get a Managed Databases type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type_id` | string | Yes | The ID of the Managed Database type. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a managed issue **Slug:** `LINODE_GET_A_MANAGED_ISSUE` Get a managed issue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `issue_id` | integer | Yes | The Issue to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a managed service monitor **Slug:** `LINODE_GET_A_MANAGED_SERVICE_MONITOR` Get a managed service monitor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `service_id` | integer | Yes | The ID of the Managed Service to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a month's Linode statistics **Slug:** `LINODE_GET_A_MONTH_S_LINODE_STATISTICS` Get a month's Linode statistics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `year` | integer | Yes | Numeric value representing the year to look up. | | `month` | integer | Yes | Numeric value representing the month to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a MySQL Managed Database **Slug:** `LINODE_GET_A_MYSQL_MANAGED_DATABASE` Get a MySQL Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a MySQL Managed Database SSL certificate **Slug:** `LINODE_GET_A_MYSQL_MANAGED_DATABASE_SSL_CERTIFICATE` Get a MySQL Managed Database SSL certificate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an account login **Slug:** `LINODE_GET_AN_ACCOUNT_LOGIN` Get an account login. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `login_id` | integer | Yes | The ID of the login object to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an alert definition **Slug:** `LINODE_GET_AN_ALERT_DEFINITION` Get an alert definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `alert_id` | integer | Yes | The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a NAT Gateway **Slug:** `LINODE_GET_A_NAT_GATEWAY` Get a NAT Gateway. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a NAT Gateway IP address **Slug:** `LINODE_GET_A_NAT_GATEWAY_IP_ADDRESS` Get a NAT Gateway IP address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | | `natgateway_address` | string | Yes | A public IPv4 NAT Gateway address. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an enrolled Beta program **Slug:** `LINODE_GET_AN_ENROLLED_BETA_PROGRAM` Get an enrolled Beta program. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `beta_id` | string | Yes | The unique identifier for the Beta program. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an event **Slug:** `LINODE_GET_AN_EVENT` Get an event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_id` | integer | Yes | The ID of the Event. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an image **Slug:** `LINODE_GET_AN_IMAGE` Get an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `image_id` | string | Yes | The unique identifier assigned to the image after creation. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an invoice **Slug:** `LINODE_GET_AN_INVOICE` Get an invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_id` | integer | Yes | The ID of the Invoice. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an IP address **Slug:** `LINODE_GET_AN_IP_ADDRESS` Get an IP address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | The address to operate on. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an IPv6 range **Slug:** `LINODE_GET_AN_IPV6_RANGE` Get an IPv6 range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `range` | string | Yes | The IPv6 range to access. Corresponds to the `range` property of objects returned from the List IPv6 ranges operation. You need to omit the prefix length of the IPv6 range. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an LKE Kubernetes version (any tier) **Slug:** `LINODE_GET_AN_LKE_KUBERNETES_VERSION_ANY_TIER` Get an LKE Kubernetes version (any tier). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tier` | string ("standard" | "enterprise") | Yes | __Enum__ The LKE tier to use. | | `version` | string | Yes | The LKE version to view. | | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an LKE Kubernetes version (non-enterprise) **Slug:** `LINODE_GET_AN_LKE_KUBERNETES_VERSION_NON_ENTERPRISE` Get an LKE Kubernetes version (non-enterprise). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version` | string | Yes | The LKE version to view. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an Object Storage bucket **Slug:** `LINODE_GET_AN_OBJECT_STORAGE_BUCKET` Get an Object Storage bucket. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an Object Storage global quota **Slug:** `LINODE_GET_AN_OBJECT_STORAGE_GLOBAL_QUOTA` Get an Object Storage global quota. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `obj_global_quota_id` | string | Yes | __Enum__ Identifies the Object Storage-related global quota to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an Object Storage object ACL configuration **Slug:** `LINODE_GET_AN_OBJECT_STORAGE_OBJECT_ACL_CONFIGURATION` Get an Object Storage object ACL configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of a specific object to get its access control list (ACL) details. Run the List Object Storage bucket contents operation to access all object names in a bucket. | | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an Object Storage quota **Slug:** `LINODE_GET_AN_OBJECT_STORAGE_QUOTA` Get an Object Storage quota. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `obj_quota_id` | string | Yes | Identifies the Object Storage-related global quota to retrieve. This follows the pattern, `-`, for example, `buckets-eu-central-1.linodeobjects.com`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a node **Slug:** `LINODE_GET_A_NODE` Get a node. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `node_id` | string | Yes | The ID of the Node to access. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster containing the Node. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a NodeBalancer **Slug:** `LINODE_GET_A_NODEBALANCER` Get a NodeBalancer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a NodeBalancer's backend IPv6 prefix **Slug:** `LINODE_GET_A_NODEBALANCER_S_BACKEND_IPV6_PREFIX` Get a NodeBalancer's backend IPv6 prefix. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a NodeBalancer's node **Slug:** `LINODE_GET_A_NODEBALANCER_S_NODE` Get a NodeBalancer's node. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `node_id` | string | Yes | The ID of the Node to access. | | `config_id` | integer | Yes | The ID of the Config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a node pool **Slug:** `LINODE_GET_A_NODE_POOL` Get a node pool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pool_id` | integer | Yes | ID of the Pool to look up. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a notification channel **Slug:** `LINODE_GET_A_NOTIFICATION_CHANNEL` Get a notification channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `channel_id` | integer | Yes | The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a placement group **Slug:** `LINODE_GET_A_PLACEMENT_GROUP` Get a placement group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | ID of the placement group to look up. Run the List placement groups operation and store the `id` for the applicable placement group. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a PostgreSQL connection pool **Slug:** `LINODE_GET_A_POSTGRESQL_CONNECTION_POOL` Get a PostgreSQL connection pool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pool_name` | string | Yes | The `label` set for a specific connection pool in a PostgreSQL Managed Database. Run the List PostgreSQL connection pools operation and store the `label` for the desired one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a PostgreSQL Managed Database **Slug:** `LINODE_GET_A_POSTGRESQL_MANAGED_DATABASE` Get a PostgreSQL Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a PostgreSQL Managed Database SSL certificate **Slug:** `LINODE_GET_A_POSTGRESQL_MANAGED_DATABASE_SSL_CERTIFICATE` Get a PostgreSQL Managed Database SSL certificate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Prefix List **Slug:** `LINODE_GET_A_PREFIX_LIST` Get a Prefix List. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `prefix_list_id` | integer | Yes | The unique Prefix List ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a profile's login **Slug:** `LINODE_GET_A_PROFILE_S_LOGIN` Get a profile's login. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `login_id` | integer | Yes | The ID of the login object to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a region **Slug:** `LINODE_GET_A_REGION` Get a region. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region_id` | string | Yes | The abbreviated value ("slug") for the applicable data center. Run the List regions operation to view the slug for each data center. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a region's VPC availability **Slug:** `LINODE_GET_A_REGION_S_VPC_AVAILABILITY` Get a region's VPC availability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region_id` | string | Yes | The abbreviated value ("slug") for the applicable data center. Run the List regions operation to view the slug for each data center. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a reserved IP address **Slug:** `LINODE_GET_A_RESERVED_IP_ADDRESS` Get a reserved IP address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | The reserved address to update, view, or delete. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a resource lock **Slug:** `LINODE_GET_A_RESOURCE_LOCK` Get a resource lock. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | | `resource_lock_id` | integer | Yes | The unique identifier assigned to the resource lock. Run the List resource locks operation and store the `id` for the applicable resource lock. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Rule Set **Slug:** `LINODE_GET_A_RULE_SET` Get a Rule Set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `rule_set_id` | integer | Yes | ID of the Rule Set to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a share group **Slug:** `LINODE_GET_A_SHARE_GROUP` Get a share group. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a StackScript **Slug:** `LINODE_GET_A_STACKSCRIPT` Get a StackScript. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `stackscript_id` | string | Yes | The ID of the StackScript to look up. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a stream **Slug:** `LINODE_GET_A_STREAM` Get a stream. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `stream_id` | integer | Yes | The unique identifier assigned to the stream. Run the List streams operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a stream's history **Slug:** `LINODE_GET_A_STREAM_S_HISTORY` Get a stream's history. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `stream_id` | integer | Yes | The unique identifier assigned to the stream. Run the List streams operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a support ticket **Slug:** `LINODE_GET_A_SUPPORT_TICKET` Get a support ticket. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ticket_id` | integer | Yes | The ID of the support ticket. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a type **Slug:** `LINODE_GET_A_TYPE` Get a type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type_id` | string | Yes | The unique `id` for the Linode type to look up. Run the List types operation to see each Linode type `class` available on your account, and store its associated `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a user's access level **Slug:** `LINODE_GET_A_USER_S_ACCESS_LEVEL` Get a user's access level. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `username` | string | Yes | The username to look up. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get available services for a region **Slug:** `LINODE_GET_AVAILABLE_SERVICES_FOR_A_REGION` Get available services for a region. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region_id` | string | Yes | The abbreviated value ("slug") for the applicable data center. Run the List regions operation to view the slug for each data center. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Valkey Managed Database **Slug:** `LINODE_GET_A_VALKEY_MANAGED_DATABASE` Get a Valkey Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Valkey Managed Database SSL certificate **Slug:** `LINODE_GET_A_VALKEY_MANAGED_DATABASE_SSL_CERTIFICATE` Get a Valkey Managed Database SSL certificate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a volume **Slug:** `LINODE_GET_A_VOLUME` Get a volume. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `x_filter` | string | No | Specifies a JSON object to filter down the results. See Filtering and sorting for details. | | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a volume quota **Slug:** `LINODE_GET_A_VOLUME_QUOTA` Get a volume quota. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `quota_id` | string | Yes | The unique string that identifies the specific Block Storage volume quota to look up. This follows the pattern `vol-{quota_type}-{region}`, for example `vol-capacity-us-east` or `vol-capacity-global`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a VPC **Slug:** `LINODE_GET_A_VPC` Get a VPC. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a VPC configuration **Slug:** `LINODE_GET_A_VPC_CONFIGURATION` Get a VPC configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | | `node_balancer_vpc_config_id` | integer | Yes | The VPC configuration `id` for the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a VPC subnet **Slug:** `LINODE_GET_A_VPC_SUBNET` Get a VPC subnet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `vpc_subnet_id` | integer | Yes | The `id` of the VPC Subnet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get CORS Object Storage bucket access (E0/E1) **Slug:** `LINODE_GET_CORS_OBJECT_STORAGE_BUCKET_ACCESS_E0_E1` Get CORS Object Storage bucket access (E0/E1). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current Profile **Slug:** `LINODE_GET_CURRENT_PROFILE` Return the connected Linode user's stable identity and security-related profile settings without contact or referral details. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get daily Linode statistics **Slug:** `LINODE_GET_DAILY_LINODE_STATISTICS` Get daily Linode statistics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get details for a supported service type **Slug:** `LINODE_GET_DETAILS_FOR_A_SUPPORTED_SERVICE_TYPE` Get details for a supported service type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get monthly network transfer stats **Slug:** `LINODE_GET_MONTHLY_NETWORK_TRANSFER_STATS` Get monthly network transfer stats. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `year` | integer | Yes | Numeric value representing the year to look up. | | `month` | integer | Yes | Numeric value representing the month to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get NAT Gateway account settings **Slug:** `LINODE_GET_NAT_GATEWAY_ACCOUNT_SETTINGS` Get NAT Gateway account settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get networking information **Slug:** `LINODE_GET_NETWORKING_INFORMATION` Get networking information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get network usage **Slug:** `LINODE_GET_NETWORK_USAGE` Get network usage. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get NodeBalancer statistics **Slug:** `LINODE_GET_NODEBALANCER_STATISTICS` Get NodeBalancer statistics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Object Storage global quota usage data **Slug:** `LINODE_GET_OBJECT_STORAGE_GLOBAL_QUOTA_USAGE_DATA` Get Object Storage global quota usage data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `obj_global_quota_id` | string | Yes | __Enum__ Identifies the Object Storage-related global quota to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Object Storage quota usage data **Slug:** `LINODE_GET_OBJECT_STORAGE_QUOTA_USAGE_DATA` Get Object Storage quota usage data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `obj_quota_id` | string | Yes | Identifies the Object Storage-related global quota to retrieve. This follows the pattern, `-`, for example, `buckets-eu-central-1.linodeobjects.com`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Object Storage transfer data **Slug:** `LINODE_GET_OBJECT_STORAGE_TRANSFER_DATA` Get Object Storage transfer data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Region Plan Availability **Slug:** `LINODE_GET_REGION_PLAN_AVAILABILITY` Return availability for every Linode compute plan in one region, including plans that are currently unavailable. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region_id` | string | Yes | Region ID from LINODE_LIST_REGIONS, for example gb-lon. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get reserved IP pricing **Slug:** `LINODE_GET_RESERVED_IP_PRICING` Get reserved IP pricing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get the account delegation for a child account **Slug:** `LINODE_GET_THE_ACCOUNT_DELEGATION_FOR_A_CHILD_ACCOUNT` Get the account delegation for a child account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `euuid` | string | Yes | A unique identifier for a child account. To get this value, run List child accounts. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get the control plane access control list **Slug:** `LINODE_GET_THE_CONTROL_PLANE_ACCESS_CONTROL_LIST` Get the control plane access control list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get the default role assignment for delegate users **Slug:** `LINODE_GET_THE_DEFAULT_ROLE_ASSIGNMENT_FOR_DELEGATE_USERS` Get the default role assignment for delegate users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get this month's network transfer stats **Slug:** `LINODE_GET_THIS_MONTH_S_NETWORK_TRANSFER_STATS` Get this month's network transfer stats. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user's account delegations **Slug:** `LINODE_GET_USER_S_ACCOUNT_DELEGATIONS` Get user's account delegations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `username` | string | Yes | The username to look up. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get volume quota usage data **Slug:** `LINODE_GET_VOLUME_QUOTA_USAGE_DATA` Get volume quota usage data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `quota_id` | string | Yes | The unique string that identifies the specific Block Storage volume quota to look up. This follows the pattern `vol-{quota_type}-{region}`, for example `vol-capacity-us-east` or `vol-capacity-global`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get your account delegations **Slug:** `LINODE_GET_YOUR_ACCOUNT_DELEGATIONS` Get your account delegations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import a domain **Slug:** `LINODE_IMPORT_A_DOMAIN` Import a domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string | No | The domain to import. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `remote_nameserver` | string | No | The remote nameserver that allows zone transfers (AXFR). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List agreements **Slug:** `LINODE_LIST_AGREEMENTS` List agreements. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List alert definitions **Slug:** `LINODE_LIST_ALERT_DEFINITIONS` List alert definitions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List alert definitions for a service type **Slug:** `LINODE_LIST_ALERT_DEFINITIONS_FOR_A_SERVICE_TYPE` List alert definitions for a service type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List alerts for a notification channel **Slug:** `LINODE_LIST_ALERTS_FOR_A_NOTIFICATION_CHANNEL` List alerts for a notification channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `channel_id` | integer | Yes | The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a Linode's firewalls **Slug:** `LINODE_LIST_A_LINODE_S_FIREWALLS` List a Linode's firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `linode_id` | integer | Yes | The ID of the Linode. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a Linode's network interface history **Slug:** `LINODE_LIST_A_LINODE_S_NETWORK_INTERFACE_HISTORY` List a Linode's network interface history. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a Linode's volumes **Slug:** `LINODE_LIST_A_LINODE_S_VOLUMES` List a Linode's volumes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a NAT Gateway's IP addresses **Slug:** `LINODE_LIST_A_NAT_GATEWAY_S_IP_ADDRESSES` List a NAT Gateway's IP addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List available roles **Slug:** `LINODE_LIST_AVAILABLE_ROLES` List available roles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List available services **Slug:** `LINODE_LIST_AVAILABLE_SERVICES` List available services. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a VPC's IPv4 addresses **Slug:** `LINODE_LIST_A_VPC_S_IPV4_ADDRESSES` List a VPC's IPv4 addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List a VPC's IPv6 addresses **Slug:** `LINODE_LIST_A_VPC_S_IPV6_ADDRESSES` List a VPC's IPv6 addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List backups **Slug:** `LINODE_LIST_BACKUPS` List backups. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The ID of the Linode the backups belong to. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Beta programs **Slug:** `LINODE_LIST_BETA_PROGRAMS` List Beta programs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List child accounts **Slug:** `LINODE_LIST_CHILD_ACCOUNTS` List child accounts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `users` | boolean | No | Users added to the account delegation for each child account, `false` by default. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List configs **Slug:** `LINODE_LIST_CONFIGS` List configs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List configuration profile interfaces **Slug:** `LINODE_LIST_CONFIGURATION_PROFILE_INTERFACES` List configuration profile interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List configuration profiles **Slug:** `LINODE_LIST_CONFIGURATION_PROFILES` List configuration profiles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `linode_id` | integer | Yes | ID of the Linode to look up Configuration profiles for. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List dashboards **Slug:** `LINODE_LIST_DASHBOARDS` List dashboards. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List dashboards for a service type **Slug:** `LINODE_LIST_DASHBOARDS_FOR_A_SERVICE_TYPE` List dashboards for a service type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List default firewalls **Slug:** `LINODE_LIST_DEFAULT_FIREWALLS` List default firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List disks **Slug:** `LINODE_LIST_DISKS` List disks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List domain records **Slug:** `LINODE_LIST_DOMAIN_RECORDS` List domain records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `domain_id` | integer | Yes | The ID of the Domain we are accessing Records for. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List domains **Slug:** `LINODE_LIST_DOMAINS` List domains. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List enrolled Beta programs **Slug:** `LINODE_LIST_ENROLLED_BETA_PROGRAMS` List enrolled Beta programs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List entities **Slug:** `LINODE_LIST_ENTITIES` List entities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List entities assigned to an alert definition **Slug:** `LINODE_LIST_ENTITIES_ASSIGNED_TO_AN_ALERT_DEFINITION` List entities assigned to an alert definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `alert_id` | integer | Yes | The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List events **Slug:** `LINODE_LIST_EVENTS` List events. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `x_filter` | string | No | Specifies a JSON object to filter down the results. See Filtering and sorting for details. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewall devices **Slug:** `LINODE_LIST_FIREWALL_DEVICES` List firewall devices. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewall rules **Slug:** `LINODE_LIST_FIREWALL_RULES` List firewall rules. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewall rules with expanded Prefix Lists and Rule Sets **Slug:** `LINODE_LIST_FIREWALL_RULES_WITH_EXPANDED_PREFIX_LISTS_AND_RULE_SETS` List firewall rules with expanded Prefix Lists and Rule Sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewall rule versions **Slug:** `LINODE_LIST_FIREWALL_RULE_VERSIONS` List firewall rule versions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewalls **Slug:** `LINODE_LIST_FIREWALLS` List firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List firewall templates **Slug:** `LINODE_LIST_FIREWALL_TEMPLATES` List firewall templates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Linode Instances **Slug:** `LINODE_LIST_INSTANCES` Return one page of compute instances owned by the connected account, including identifiers and operational metadata needed for inventory workflows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum records to return in this page (25-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Instance Types **Slug:** `LINODE_LIST_INSTANCE_TYPES` Return one page of Linode compute plans with hardware specifications, transfer allowances, and base, regional, and backup pricing for cost planning. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum records to return in this page (25-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List interfaces using a NAT Gateway IP **Slug:** `LINODE_LIST_INTERFACES_USING_A_NAT_GATEWAY_IP` List interfaces using a NAT Gateway IP. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | | `natgateway_address` | string | Yes | A public IPv4 NAT Gateway address. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List invoice items **Slug:** `LINODE_LIST_INVOICE_ITEMS` List invoice items. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `invoice_id` | integer | Yes | The ID of the Invoice. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List invoices **Slug:** `LINODE_LIST_INVOICES` List invoices. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `x_filter` | string | No | Specifies a JSON object to filter down the results. See Filtering and sorting for details. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List IP addresses **Slug:** `LINODE_LIST_IP_ADDRESSES` List IP addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `skip_ipv6_rdns` | boolean | No | When `true`, the `rdns` property for any `ipv6` type addresses always returns `null` regardless of whether RDNS data exists for the address. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List IPv6 pools **Slug:** `LINODE_LIST_IPV6_POOLS` List IPv6 pools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List IPv6 ranges **Slug:** `LINODE_LIST_IPV6_RANGES` List IPv6 ranges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Kernels **Slug:** `LINODE_LIST_KERNELS` Return one page of Linode kernels with architecture, virtualization compatibility, version, build date, and deprecation status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum records to return in this page (25-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Kubernetes API endpoints **Slug:** `LINODE_LIST_KUBERNETES_API_ENDPOINTS` List Kubernetes API endpoints. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Kubernetes clusters **Slug:** `LINODE_LIST_KUBERNETES_CLUSTERS` List Kubernetes clusters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Kubernetes types **Slug:** `LINODE_LIST_KUBERNETES_TYPES` List Kubernetes types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Linode interface firewalls **Slug:** `LINODE_LIST_LINODE_INTERFACE_FIREWALLS` List Linode interface firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Linode interfaces **Slug:** `LINODE_LIST_LINODE_INTERFACES` List Linode interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Linode interface settings **Slug:** `LINODE_LIST_LINODE_INTERFACE_SETTINGS` List Linode interface settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Linode NodeBalancers **Slug:** `LINODE_LIST_LINODE_NODEBALANCERS` List Linode NodeBalancers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List LKE Kubernetes versions (any tier) **Slug:** `LINODE_LIST_LKE_KUBERNETES_VERSIONS_ANY_TIER` List LKE Kubernetes versions (any tier). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tier` | string ("standard" | "enterprise") | Yes | __Enum__ The LKE tier to use. | | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List LKE Kubernetes versions (non-enterprise) **Slug:** `LINODE_LIST_LKE_KUBERNETES_VERSIONS_NON_ENTERPRISE` List LKE Kubernetes versions (non-enterprise). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List logins **Slug:** `LINODE_LIST_LOGINS` List logins. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Longview subscriptions **Slug:** `LINODE_LIST_LONGVIEW_SUBSCRIPTIONS` List Longview subscriptions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Longview types **Slug:** `LINODE_LIST_LONGVIEW_TYPES` List Longview types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List maintenance policies **Slug:** `LINODE_LIST_MAINTENANCE_POLICIES` List maintenance policies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List maintenances **Slug:** `LINODE_LIST_MAINTENANCES` List maintenances. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List managed contacts **Slug:** `LINODE_LIST_MANAGED_CONTACTS` List managed contacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Managed Databases **Slug:** `LINODE_LIST_MANAGED_DATABASES` List Managed Databases. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Managed Databases engines **Slug:** `LINODE_LIST_MANAGED_DATABASES_ENGINES` List Managed Databases engines. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Managed Databases types **Slug:** `LINODE_LIST_MANAGED_DATABASES_TYPES` List Managed Databases types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List managed issues **Slug:** `LINODE_LIST_MANAGED_ISSUES` List managed issues. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List managed Linode settings **Slug:** `LINODE_LIST_MANAGED_LINODE_SETTINGS` List managed Linode settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List managed services **Slug:** `LINODE_LIST_MANAGED_SERVICES` List managed services. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List managed stats **Slug:** `LINODE_LIST_MANAGED_STATS` List managed stats. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List metrics for a service type **Slug:** `LINODE_LIST_METRICS_FOR_A_SERVICE_TYPE` List metrics for a service type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `x_filter` | object | No | Specifies a JSON object to filter down the results. See Filtering and sorting for details. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List MySQL Managed Database advanced parameters **Slug:** `LINODE_LIST_MYSQL_MANAGED_DATABASE_ADVANCED_PARAMETERS` List MySQL Managed Database advanced parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List MySQL Managed Databases **Slug:** `LINODE_LIST_MYSQL_MANAGED_DATABASES` List MySQL Managed Databases. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NAT Gateway interfaces **Slug:** `LINODE_LIST_NAT_GATEWAY_INTERFACES` List NAT Gateway interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NAT Gateways **Slug:** `LINODE_LIST_NAT_GATEWAYS` List NAT Gateways. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NAT Gateway types **Slug:** `LINODE_LIST_NAT_GATEWAY_TYPES` List NAT Gateway types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Network Transfer Prices **Slug:** `LINODE_LIST_NETWORK_TRANSFER_PRICES` Return current base and region-specific network transfer prices for estimating Linode data-transfer costs. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NodeBalancer firewalls **Slug:** `LINODE_LIST_NODEBALANCER_FIREWALLS` List NodeBalancer firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NodeBalancers **Slug:** `LINODE_LIST_NODEBALANCERS` List NodeBalancers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List NodeBalancer types **Slug:** `LINODE_LIST_NODEBALANCER_TYPES` List NodeBalancer types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List node pools **Slug:** `LINODE_LIST_NODE_POOLS` List node pools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List nodes **Slug:** `LINODE_LIST_NODES` List nodes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `config_id` | integer | Yes | The ID of the NodeBalancer config to access. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List notification channels **Slug:** `LINODE_LIST_NOTIFICATION_CHANNELS` List notification channels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List notifications **Slug:** `LINODE_LIST_NOTIFICATIONS` List notifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage bucket contents **Slug:** `LINODE_LIST_OBJECT_STORAGE_BUCKET_CONTENTS` List Object Storage bucket contents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bucket` | string | Yes | The bucket name. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `marker` | string | No | The "marker" for this request, which can be used to paginate through large buckets. Its value should be the value of the `next_marker` property returned with the last page. Listing bucket contents _does not_ support arbitrary page access. See the `next_marker` property in the responses section for more details. | | `prefix` | string | No | Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with `delimiter` to allow transversal of bucket contents in a manner similar to a file system. | | `delimiter` | string | No | The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the `/` character to allow bucket transversal in a manner similar to a file system, however any delimiter may be used. Use in conjunction with `prefix` to see object names past the first occurrence of the delimiter. | | `page_size` | integer | No | The number of items to return per page. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage buckets **Slug:** `LINODE_LIST_OBJECT_STORAGE_BUCKETS` List Object Storage buckets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage buckets per region **Slug:** `LINODE_LIST_OBJECT_STORAGE_BUCKETS_PER_REGION` List Object Storage buckets per region. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage endpoints **Slug:** `LINODE_LIST_OBJECT_STORAGE_ENDPOINTS` List Object Storage endpoints. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage global quotas **Slug:** `LINODE_LIST_OBJECT_STORAGE_GLOBAL_QUOTAS` List Object Storage global quotas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage quotas **Slug:** `LINODE_LIST_OBJECT_STORAGE_QUOTAS` List Object Storage quotas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Object Storage types **Slug:** `LINODE_LIST_OBJECT_STORAGE_TYPES` List Object Storage types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List placement groups **Slug:** `LINODE_LIST_PLACEMENT_GROUPS` List placement groups. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List PostgreSQL connection pools **Slug:** `LINODE_LIST_POSTGRESQL_CONNECTION_POOLS` List PostgreSQL connection pools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List PostgreSQL Managed Database advanced parameters **Slug:** `LINODE_LIST_POSTGRESQL_MANAGED_DATABASE_ADVANCED_PARAMETERS` List PostgreSQL Managed Database advanced parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List PostgreSQL Managed Databases **Slug:** `LINODE_LIST_POSTGRESQL_MANAGED_DATABASES` List PostgreSQL Managed Databases. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Prefix Lists **Slug:** `LINODE_LIST_PREFIX_LISTS` List Prefix Lists. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Public Images **Slug:** `LINODE_LIST_PUBLIC_IMAGES` Return one page of public Linode operating-system images and lifecycle metadata; private account images are intentionally excluded. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum records to return in this page (25-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Regions **Slug:** `LINODE_LIST_REGIONS` Return one page of Linode regions with status, location, service capabilities, site type, and placement limits for deployment planning. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum records to return in this page (25-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List regions' availability **Slug:** `LINODE_LIST_REGIONS_AVAILABILITY` List regions' availability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List regions' VPC availability **Slug:** `LINODE_LIST_REGIONS_VPC_AVAILABILITY` List regions' VPC availability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List replies **Slug:** `LINODE_LIST_REPLIES` List replies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `ticket_id` | integer | Yes | The ID of the support ticket. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List reserved IP addresses **Slug:** `LINODE_LIST_RESERVED_IP_ADDRESSES` List reserved IP addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List resource locks **Slug:** `LINODE_LIST_RESOURCE_LOCKS` List resource locks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4beta` URL for operations still only in beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Rule Sets **Slug:** `LINODE_LIST_RULE_SETS` List Rule Sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List shared images by group **Slug:** `LINODE_LIST_SHARED_IMAGES_BY_GROUP` List shared images by group. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List share groups **Slug:** `LINODE_LIST_SHARE_GROUPS` List share groups. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List share groups by image **Slug:** `LINODE_LIST_SHARE_GROUPS_BY_IMAGE` List share groups by image. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `image_id` | string | Yes | Slug identifier assigned to the private image upon creation. This is the `id` value returned in the List images operation. The identifier includes a slash (`/`), which must be URL-encoded in requests to prevent breaking the URL structure. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SSO-required users **Slug:** `LINODE_LIST_SSO_REQUIRED_USERS` List SSO-required users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `idp_config_id` | string | Yes | The unique identifier of the external identity provider configuration. This is the `id` value returned by the List IDP configurations operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SSO user exceptions **Slug:** `LINODE_LIST_SSO_USER_EXCEPTIONS` List SSO user exceptions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `idp_config_id` | string | Yes | The unique identifier of the external identity provider configuration. This is the `id` value returned by the List IDP configurations operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List StackScripts **Slug:** `LINODE_LIST_STACKSCRIPTS` List StackScripts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List streams **Slug:** `LINODE_LIST_STREAMS` List streams. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List supported service types **Slug:** `LINODE_LIST_SUPPORTED_SERVICE_TYPES` List supported service types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List support tickets **Slug:** `LINODE_LIST_SUPPORT_TICKETS` List support tickets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List tagged objects **Slug:** `LINODE_LIST_TAGGED_OBJECTS` List tagged objects. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `tag_label` | string | Yes | The `label` of the tag to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List tags **Slug:** `LINODE_LIST_TAGS` List tags. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List user logins **Slug:** `LINODE_LIST_USER_LOGINS` List user logins. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Valkey Managed Database advanced parameters **Slug:** `LINODE_LIST_VALKEY_MANAGED_DATABASE_ADVANCED_PARAMETERS` List Valkey Managed Database advanced parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Valkey Managed Databases **Slug:** `LINODE_LIST_VALKEY_MANAGED_DATABASES` List Valkey Managed Databases. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VLANs **Slug:** `LINODE_LIST_VLANS` List VLANs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List volume quotas **Slug:** `LINODE_LIST_VOLUME_QUOTAS` List volume quotas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List volumes **Slug:** `LINODE_LIST_VOLUMES` List volumes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `x_filter` | string | No | Specifies a JSON object to filter down the results. See Filtering and sorting for details. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List volume types **Slug:** `LINODE_LIST_VOLUME_TYPES` List volume types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPC configurations **Slug:** `LINODE_LIST_VPC_CONFIGURATIONS` List VPC configurations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPC default and forbidden IPv4 ranges **Slug:** `LINODE_LIST_VPC_DEFAULT_AND_FORBIDDEN_IPV4_RANGES` List VPC default and forbidden IPv4 ranges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPC IPv4 addresses **Slug:** `LINODE_LIST_VPC_IPV4_ADDRESSES` List VPC IPv4 addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPC IPv6 addresses **Slug:** `LINODE_LIST_VPC_IPV6_ADDRESSES` List VPC IPv6 addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPCs **Slug:** `LINODE_LIST_VPCS` List VPCs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List VPC subnets **Slug:** `LINODE_LIST_VPC_SUBNETS` List VPC subnets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | The page of a collection to return. | | `cursor` | string | No | Opaque cursor from the previous page; omit for the first page. | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `page_size` | integer | No | The number of items to return per page. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Mark an event as seen **Slug:** `LINODE_MARK_AN_EVENT_AS_SEEN` Mark an event as seen. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_id` | integer | Yes | The ID of the Event to designate as seen. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Migrate a Linode **Slug:** `LINODE_MIGRATE_A_LINODE` Migrate a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("warm" | "cold") | No | Type of migration used in moving to a new host or Linode type. `warm`: the Linode will not power down until the migration is complete. Warm migrations are not available for DC migrations. `cold`: the Linode will be powered down and migrated. When the migration is complete, the Linode will be powered on. | | `region` | string | No | The region to which the Linode will be migrated. Must be a valid region slug. A list of regions can be viewed by running the List regions operation. A cross data center migration will cancel a pending migration that has not yet been initiated. A cross data center migration will initiate a `linode_migrate_datacenter_create` event. | | `upgrade` | boolean | No | When initiating a cross DC migration, setting this value to `true` will also ensure that the Linode is upgraded to the latest generation of hardware that corresponds to your Linode's Type, if any free upgrades are available for it. If no free upgrades are available, and this value is set to `true`, then the endpoint will return a 400 error code and the migration will not be performed. If the data center set in the `region` field does not allow upgrades, then the endpoint will return a 400 error code and the migration will not be performed. | | `linode_id` | integer | Yes | ID of the Linode to migrate. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `placement_group` | object | No | Include this to assign this Linode to an existing placement group in the data center you're migrating to. These constraints apply: - If the target Linode is in a placement group, it will be removed from it when migrating. - The target placement group needs to be in the same `region` you're migrating to. - The placement group needs to have capacity. Run the Get a region operation and note either the `maximum_linodes_per_pg` (strict) or `maximum_linodes_per_flexible_pg` (flexible), based on your selected `placement_group_policy`. These represent the Linode limit per placement group, for each `placement_group_policy` type. You can then run the Get a placement group operation to review the Linodes in that group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Open a support ticket **Slug:** `LINODE_OPEN_A_SUPPORT_TICKET` Open a support ticket. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vlan` | string | No | The label of the VLAN entity for the ticket. Run the List VLANs operation and store the `id` for the target VLAN. You also need to provide the specific `region` where the VLAN is located. | | `bucket` | string | No | The name of an Object Storage bucket entity for this ticket. Run the List Object Storage buckets operation and store the `label` for the target bucket. You also need to provide the specific `region` where the bucket is located. | | `region` | string | No | The ID of the region where this ticket's target entity resides. This only applies to tickets for a `vlan` or an Object Storage `bucket`. Set this to the `clusterId` for a legacy Object Storage `bucket`. | | `vpc_id` | integer | No | The ID of the VPC entity for the ticket. Run the List VPCs operation and store the `id` for the target VPC. | | `summary` | string | No | The summary or title for this support ticket. | | `severity` | integer ("1" | "2" | "3" | "4") | No | The severity of the issue. Available values include: - `1` - Major impact - `2` - Moderate impact - `3` - Low impact - `4` - No impact If omitted or set to `null`, the ticket is created with no assigned severity level. Your account may not have access to set this value. Talk to your Akamai account team for more details. | | `domain_id` | integer | No | The ID of the domain entity for the ticket. Run the List domains operation and store the `id` for the target domain. | | `linode_id` | integer | No | The ID of the Linode entity for the ticket. Run the List Linodes operation and store the `id` for the target Linode. | | `volume_id` | integer | No | The ID of the volume entity for the ticket. Run the List volumes operation and store the `id` for the target volume. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `database_id` | integer | No | The ID of the Managed Database entity for the ticket. Run the List Managed Databases operation and store the `id` for the target database. | | `description` | string | No | The full details of the issue or question. | | `firewall_id` | integer | No | The ID of the Firewall entity for the ticket. Run the List a Linode's firewalls operation and store the `id` for the target Linode firewall. | | `request_type` | string ("service_issue" | "information_request" | "account_request" | "feature_request") | No | The type of request this support ticket represents. Available request types include: - `service_issue`. Use when experiencing a problem, error, or degradation with a service. - `information_request`. Use for general inquiries, asking for clarification, documentation, or guidance on using a service. - `account_request`. Use for matters related to account management. - `feature_request`. Use to suggest a new feature or enhancement. | | `lkecluster_id` | integer | No | The ID of the Linode Kubernetes Engine (LKE) cluster entity for the ticket. Run the List Kubernetes clusters operation and store the `id` for the target LKE cluster. | | `managed_issue` | boolean | No | Whether this ticket is related to a managed service. If `true`, the following constraints apply: - You can't provide an entity, such as a `linode_id` or `bucket` with this request. - Your account needs a managed service enabled. | | `nodebalancer_id` | integer | No | The ID of the NodeBalancer entity for the ticket. Run the List NodeBalancers operation and store the `id` for the target NodeBalancer. | | `longviewclient_id` | integer | No | The ID of the Longview client entity for the ticket. Run the List Longview clients operation and store the `id` for the target client. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch a MySQL Managed Database **Slug:** `LINODE_PATCH_A_MYSQL_MANAGED_DATABASE` Patch a MySQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch a PostgreSQL Managed Database **Slug:** `LINODE_PATCH_A_POSTGRESQL_MANAGED_DATABASE` Patch a PostgreSQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch a Valkey Managed Database **Slug:** `LINODE_PATCH_A_VALKEY_MANAGED_DATABASE` Patch a Valkey Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Preview Linode interface upgrade **Slug:** `LINODE_PREVIEW_LINODE_INTERFACE_UPGRADE` Preview the Linode interface upgrade. This always performs a dry run and makes no changes to the Linode or its interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | No | The Linode's `config_id`. Only one `config_id` can be specified: - If there are no legacy configuration interfaces or configurations defined in the config_id, a public interface is created using the Linode's automatically assigned public IPv4 address. - If a config_id is not provided and the Linode has only one configuration, the upgrade automatically uses that config_id. - If the Linode has multiple configurations and a config_id is not specified, an error is returned. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reboot a Linode **Slug:** `LINODE_REBOOT_A_LINODE` Reboot a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | No | The Linode Config ID to reboot into. If `null` or omitted, the last booted config will be used. If there was no last booted config and this Linode only has one config, it will be used. If a config cannot be determined, an error will be returned. | | `linode_id` | integer | Yes | ID of the linode to reboot. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rebuild a Linode **Slug:** `LINODE_REBUILD_A_LINODE` Rebuild a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | The ID of the Linode type to resize to with this request. | | `image` | string | Yes | The identifier assigned to the disk image to be deployed to the new Linode. You can run the List images operation with authentication to view all available images, and store the `id` from the applicable one. Official Linode images start with `linode/`, while any custom images available on your account start with `private/`. To create a disk from a `private/` image, you need `read_only` or `read_write` permissions for it. Run the Update a user's grants operation to adjust permissions for a `private/` image, or talk to your local account administrator. | | `alerts` | object | No | Include this to configure Akamai Cloud Pulse (ACLP) format alerts for the rebuilt Linode. ACLP offers more granular control of your alerts, allowing you to define custom alerts or use system-generated ones. If you leave this out of the request, legacy alerts format will be applied on the rebuilt Linode. This format automatically applies several pre-defined alerts, with default settings to the cloned Linode. - Alerts settings for a Linode are not carried through to a new Linode after a rebuild. This applies to both Akamai Cloud Pulse (ACLP) and legacy alerts formats. See Rebuild a Linode and alerts for more information. - If you include this and enable ACLP alerts format on the rebuilt Linode, you can't revert to legacy alerts format. - This only applies to rebuilds to a new Linode. You can't target an existing Linode with the `linode_id` field and include the `alerts` field. In this case, the alerts settings applied on the existing Linode still apply. | | `booted` | boolean | No | __Write-only__ The boot status of the Linode after deployment. This defaults to `true` if you create the Linode using an image or from a backup. Set this to `false` to have it remain `offline` after deployment. | | `linode_id` | integer | Yes | ID of the Linode to rebuild. | | `root_pass` | string | Yes | __Write-only__ This sets the root user's password on a newly created Linode disk when deploying from an `image`. A `root_pass` needs to meet a password strength score requirement that is calculated internally by the API. If the strength requirement isn't met, you'll receive a `Password does not meet strength requirement` error. You need to set at least one form of authentication to access a Linode disk. This can be a `root_pass`, `authorized_keys`, or `authorized_users`. You can optionally combine a `root_pass` and either `authorized_keys` or `authorized_users` for added security. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `disk_encryption` | string ("enabled" | "disabled") | No | Whether disk encryption is applied on this Linode. Local disk encryption ensures that your data is secured. Disk encryption protects against unauthorized data access by keeping the data encrypted if the disk is ever removed from the data center, decommissioned, or disposed of. The platform manages the encryption and decryption for you. By default, encryption is `enabled` on all Linodes. If you opted out of encryption or if the Linode was created prior to local disk encryption support, you can encrypt your data using the Rebuild a Linode operation. | | `maintenance_policy` | string ("linode/migrate" | "linode/power_off_on") | No | Defines the maintenance policy for this Linode. This can be one of two policies: - `linode/migrate`. This migrates the Linode to a new host while it remains fully operational, but with some performance degradation. This focuses on maximizing availability. - `linode/power_off_on`. This powers off the Linode at the start of the maintenance event and reboots it once the maintenance finishes. This focuses on maximizing performance. Review the maintenance policy documentation for more details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rebuild a NodeBalancer config **Slug:** `LINODE_REBUILD_A_NODEBALANCER_CONFIG` Rebuild a non-TLS NodeBalancer config; existing nodes omitted from nodes are deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `port` | integer | No | This is the port the NodeBalancer listens on for this configuration. Port numbers must be unique across TCP, HTTP, and HTTPS configurations on a single NodeBalancer. However, ports assigned to TCP, HTTP, or HTTPS configurations can also be reused for UDP configurations. For example, Port 80 can simultaneously serve a TCP and a UDP configuration on the same NodeBalancer, but it can't be shared by both a TCP and an HTTP configuration. Although certain ports are traditionally associated with specific protocols, this isn't strictly enforced, and you may configure your NodeBalancer however you find useful. | | `check` | string ("none" | "connection" | "http" | "http_body") | No | The type of check to perform against backends to ensure they are serving requests. The `check` 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. | | `nodes` | array | Yes | The NodeBalancer nodes that serve this config. Some considerations for Nodes when rebuilding a config: - Current Nodes excluded from the request body will be deleted from the Config. - Current Nodes (identified by their Node ID) will be updated. - New Nodes (included without a Node ID) will be created. | | `protocol` | string ("tcp" | "http" | "udp") | Yes | The non-TLS protocol this configuration serves. | | `algorithm` | string ("roundrobin" | "leastconn" | "source") | No | The algorithm this NodeBalancer configuration uses to route traffic to backends. | | `config_id` | integer | Yes | The ID of the Config to access. | | `check_body` | string | No | Use when the active health `check` type is `http_body`. 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. | | `check_path` | string | No | The URL path to check on each backend. Use when the active health `check` type is `http`. If the backend doesn't respond to this request, it's considered to be down. | | `stickiness` | string ("none" | "table" | "http_cookie") | No | 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. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `check_passive` | boolean | No | 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. | | `check_timeout` | integer | No | How long, in seconds, to wait for a check attempt before considering it failed. Must be less than `check_interval`. | | `check_attempts` | integer | No | How many times to attempt a check before considering a backend to be down. | | `check_interval` | integer | No | How often, in seconds, to check that backends are up and serving requests. Must be greater than `check_timeout`. | | `proxy_protocol` | string ("none" | "v1" | "v2") | No | Proxy protocol mode. v1 and v2 require the tcp protocol. | | `udp_check_port` | integer | No | UDP NodeBalancers use TCP and HTTP active health checks to ensure back-end nodes can receive traffic. You can specify the health check port that the backend node listens on, which may differ from the UDP port used to serve traffic. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Recycle a node **Slug:** `LINODE_RECYCLE_A_NODE` Recycle a node. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `node_id` | string | Yes | ID of the Node to be recycled. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster containing the Node. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Recycle a node pool **Slug:** `LINODE_RECYCLE_A_NODE_POOL` Recycle a node pool. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pool_id` | integer | Yes | ID of the Node Pool to be recycled. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster this Node Pool is attached to. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Recycle cluster nodes **Slug:** `LINODE_RECYCLE_CLUSTER_NODES` Recycle cluster nodes. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cluster_id` | integer | Yes | ID of the Kubernetes cluster which contains nodes to be recycled. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove a NAT Gateway IP address **Slug:** `LINODE_REMOVE_A_NAT_GATEWAY_IP_ADDRESS` Remove a NAT Gateway IP address. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | | `natgateway_address` | string | Yes | A public IPv4 NAT Gateway address. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove an Object Storage bucket **Slug:** `LINODE_REMOVE_AN_OBJECT_STORAGE_BUCKET` Remove an Object Storage bucket. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reorder configuration profile interfaces **Slug:** `LINODE_REORDER_CONFIGURATION_PROFILE_INTERFACES` Reorder configuration profile interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | Yes | An ordered array of existing configuration profile interface `id` values. - All current Interface `id`s must be present in the array. - If the Configuration Profile contains Interfaces and is active on the Linode, the Linode must first be shut down prior to running this operation. - Reordering takes effect after rebooting the Linode with this Configuration Profile. The position in the array determines which of the Linode's network Interfaces is configured: - First [0]: eth0 - Second [1]: eth1 - Third [2]: eth2 | | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replicate an image **Slug:** `LINODE_REPLICATE_AN_IMAGE` Replicate an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `regions` | array | No | The unique identifier for each compute `region`. See Regions and images for full details on support for `regions`. | | `image_id` | string | Yes | The unique identifier assigned to the image after creation. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reserve a public IPv4 address **Slug:** `LINODE_RESERVE_A_PUBLIC_IPV4_ADDRESS` Reserve a public IPv4 address. This operation is destructive and may be irreversible. This operation may provision billable resources and incur Linode charges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Tags to apply to this IP that match existing tags. | | `region` | string | Yes | Reserve a public IPv4 address from the specified region. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resize a disk **Slug:** `LINODE_RESIZE_A_DISK` Resize a disk. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | integer | Yes | The desired size, in MB, of the disk. | | `disk_id` | integer | Yes | ID of the Disk to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resize a Linode **Slug:** `LINODE_RESIZE_A_LINODE` Resize a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The ID representing the Linode Type. | | `linode_id` | integer | Yes | ID of the Linode to resize. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `migration_type` | string ("warm" | "cold") | No | Type of migration used in moving to a new host or Linode type. `warm`: the Linode will not power down until the migration is complete. Warm migrations are not available for DC migrations. `cold`: the Linode will be powered down and migrated. When the migration is complete, the Linode will be powered on. | | `allow_auto_disk_resize` | boolean | No | Automatically resize disks when resizing a Linode. When resizing down to a smaller plan your Linode's data must fit within the smaller disk size. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resize a volume **Slug:** `LINODE_RESIZE_A_VOLUME` Resize a volume. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | integer | Yes | __Filterable__ The volume's size, in gigabytes. | | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Restore a backup **Slug:** `LINODE_RESTORE_A_BACKUP` Restore a backup. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `backup_id` | integer | Yes | The ID of the Backup to restore. | | `linode_id` | integer | Yes | The ID of the Linode that the Backup belongs to. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resume a MySQL Managed Database **Slug:** `LINODE_RESUME_A_MYSQL_MANAGED_DATABASE` Resume a MySQL Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resume a PostgreSQL Managed Database **Slug:** `LINODE_RESUME_A_POSTGRESQL_MANAGED_DATABASE` Resume a PostgreSQL Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resume a Valkey Managed Database **Slug:** `LINODE_RESUME_A_VALKEY_MANAGED_DATABASE` Resume a Valkey Managed Database. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke access to a shared image **Slug:** `LINODE_REVOKE_ACCESS_TO_A_SHARED_IMAGE` Revoke access to a shared image. This operation is available only through Linode API v4beta. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `image_id` | string | Yes | Slug identifier assigned to the shared image upon sharing. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Share IP addresses **Slug:** `LINODE_SHARE_IP_ADDRESSES` Share IP addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ips` | array | Yes | A list of secondary Linode IPs to share with the primary Linode. - Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths) - Can include both private and public IPv4 addresses. - You must have access to all of these addresses and they must be in the same Region as the primary Linode. - Enter an empty array to remove all shared IP addresses. | | `linode_id` | integer | Yes | The ID of the primary Linode that the addresses will be shared with. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Shut down a Linode **Slug:** `LINODE_SHUT_DOWN_A_LINODE` Shut down a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to shutdown. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Suspend a MySQL Managed Database **Slug:** `LINODE_SUSPEND_A_MYSQL_MANAGED_DATABASE` Suspend a MySQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Suspend a PostgreSQL Managed Database **Slug:** `LINODE_SUSPEND_A_POSTGRESQL_MANAGED_DATABASE` Suspend a PostgreSQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Suspend a Valkey Managed Database **Slug:** `LINODE_SUSPEND_A_VALKEY_MANAGED_DATABASE` Suspend a Valkey Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unassign a placement group **Slug:** `LINODE_UNASSIGN_A_PLACEMENT_GROUP` Unassign a placement group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linodes` | array | No | The `linodeId` values for individual Linodes included in the placement group. | | `group_id` | integer | Yes | ID of the placement group to look up. Run the List placement groups operation and store the `id` for the applicable placement group. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unreserve an IP address **Slug:** `LINODE_UNRESERVE_AN_IP_ADDRESS` Unreserve an IP address. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | The reserved address to update, view, or delete. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a configuration profile **Slug:** `LINODE_UPDATE_A_CONFIGURATION_PROFILE` Update a configuration profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | __Filterable__ The name of the configuration for display in Akamai Cloud Manager. | | `kernel` | string | No | The ID of the kernel used to boot a Linode. Run the List kernels operation to see all available kernels. Here are some commonly used kernels: - `linode/latest-64bit`. This is the default, our latest kernel at the time of an instance boot or reboot. - `linode/grub2`. The upstream distribution-supplied kernel that's installed on the primary disk, or a custom kernel if installed. - `linode/direct-disk`. The master boot record (MBR) of the primary disk or root device. Use this in place of a Linux kernel. | | `devices` | object | No | 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. | | `helpers` | object | No | Helpers enabled when booting to this Linode configuration. | | `comments` | string | No | Optional field for arbitrary user comments on this configuration. | | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `run_level` | string ("default" | "single" | "binbash") | No | Defines the state of your Linode after booting and can be either `default`, `single`, or `binbash`. Defaults to `default`. | | `virt_mode` | string ("paravirt" | "fullvirt") | No | 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. | | `interfaces` | array | No | `interfaces` is applicable only to legacy configuration profiles and does not apply to Linode interfaces. From one to three network interfaces to add to this Linode's configuration profile. The position in the array determines which of the Linode's network interfaces is configured: - First [0]: `eth0` - Second [1]: `eth1` - Third [2]: `eth2` When updating a Linode's legacy interfaces, _each interface must be redefined_. An empty `interfaces` array results in a default `public` type 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. Changes to Linode Interface configurations can be enabled by rebooting the Linode. `vpc` details See the VPC documentation guide for its specifications and limitations. `vlan` details - Only Next Generation Network (NGN) data centers support VLANs. Run the List regions operation 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 or cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - See the VLANs Overview guide to view additional specifications and limitations. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `root_device` | string | No | The root device to boot. - If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`. - If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted. | | `memory_limit` | integer | No | Defaults to the total RAM of the Linode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a configuration profile interface **Slug:** `LINODE_UPDATE_A_CONFIGURATION_PROFILE_INTERFACE` Update a configuration profile interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ipv4` | object | No | IPv4 addresses configured for this interface. This only applies to interfaces with a `purpose` of `vpc`. | | `ipv6` | object | No | IPv6 assigned through `slaac` and `ranges`. If omitted, or `null`, the IPv6 configuration is unchanged. This only applies to interfaces with a `purpose` of `vpc`. | | `primary` | boolean | No | Designates this interface as the preferred interface for assignment of IPv4 and IPv6 default routes. Each Linode can have only one VPC or public interface set as `primary`. VLAN interfaces are always `false`. For each default route, the system selects a recipient non-VLAN interface based on the following criteria: - Interfaces with a matching IP address (IPv4 or IPv6) are preferred over those without a match. - If multiple interfaces are eligible to be the default route, the system first selects the one designated as `primary`. - If no eligible interface is designated as `primary`, the tie is broken in favor of the earliest-declared eligible interface listed in the configuration profile. | | `config_id` | integer | Yes | The `id` of the Configuration Profile. | | `ip_ranges` | array | No | IPv4 CIDR VPC subnet ranges that are routed to this interface. - A range can't include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Include this as an empty array (`[]`) to remove all existing values. - Omit this array to leave all existing `ip_ranges` as is. This only applies to interfaces with a `purpose` of `vpc`. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode Configuration Profile Interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a disk **Slug:** `LINODE_UPDATE_A_DISK` Update a disk. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | __Filterable__ The name of the disk. This is for display purposes only. | | `disk_id` | integer | Yes | ID of the Disk to look up. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a domain **Slug:** `LINODE_UPDATE_A_DOMAIN` Update a domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ An array of tags applied to this object. Tags are for organizational purposes only. | | `type` | string ("master" | "slave") | No | 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`). | | `group` | string | No | __Deprecated__, __Filterable__ The group this domain belongs to. This is for display purposes only. | | `domain` | string | No | __Filterable__ The domain this domain represents. domain labels cannot be longer than 63 characters and must conform to RFC1035. domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two domains representing the same domain. | | `status` | string ("disabled" | "active") | No | Indicates whether this domain is currently being rendered, either `active` or `disabled`. | | `ttl_sec` | integer | No | "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, 30, 120, 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 | No | 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. This is potentially dangerous, and should be set to an empty list unless you intend to use it. | | `domain_id` | integer | Yes | The ID of the Domain to access. | | `retry_sec` | integer | No | The interval, in seconds, at which a failed refresh should be retried. - Valid values are 0, 30, 120, 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 | No | Start of Authority email address. This is required for `type` master domains. | | `expire_sec` | integer | No | The amount of time in seconds that may pass before this domain is no longer authoritative. - Valid values are 0, 30, 120, 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. | | `master_ips` | array | No | 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. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A description for this domain. This is for display purposes only. | | `refresh_sec` | integer | No | The amount of time in seconds before this domain should be refreshed. - Valid values are 0, 30, 120, 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a domain record **Slug:** `LINODE_UPDATE_A_DOMAIN_RECORD` Update a domain record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag` | string ("issue" | "issuewild" | "iodef") | No | __Filterable__ The tag portion of a CAA record, either `issue`, `issuewild`, or `iodef`. See CAA records for details on these possible tag values. Only valid and required for CAA record requests. | | `name` | string | No | __Filterable__ 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. - The left-most subdomain component may be an asterisk (`*`) to designate a wildcard subdomain. - Other subdomain components must only contain letters, digits, and hyphens, start with a letter, end with a letter or digit, and contain less than 64 characters. - 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). | | `port` | integer | No | The port this Record points to. Only valid and required for SRV record requests. | | `target` | string | No | __Filterable__ 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. Required. - Must have less than 254 total characters. - The left-most domain component may be an asterisk (`*`) to designate a wildcard domain. - Other domain components must only contain letters, digits, and hyphens, start with a letter, end with a letter or digit, and contain less than 64 characters. - To create a Null MX Record, first remove any additional MX records, then 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. `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 include a valid domain. May include additional parameters separated with semicolons (`;`), for example: `www.example.com; foo=bar` - `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). With the exception of A, AAAA, and CAA records, this field accepts a trailing period. | | `weight` | integer | No | 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. | | `service` | string | No | 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. | | `ttl_sec` | integer | No | "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 | No | 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 | No | 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. | | `domain_id` | integer | Yes | The ID of the Domain whose Record you are accessing. | | `record_id` | integer | Yes | The ID of the Record you are accessing. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a firewall **Slug:** `LINODE_UPDATE_A_FIREWALL` Update a firewall. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ An array of tags applied to this object. Tags are for organizational purposes only. | | `label` | string | No | __Filterable__ 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, hyphens (`-`), underscores (`_`) or periods (`.`). - Cannot have two hyphens (`--`), underscores (`__`) or periods (`..`) in a row. - Must be between 3 and 32 characters. - Must be unique. | | `status` | string ("enabled" | "disabled") | No | The status to be applied to this Firewall. - When a Firewall is first created its status is `enabled`. - An assigned default firewall can't be disabled. - Run the Delete a firewall operation to delete a Firewall. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Kubernetes cluster **Slug:** `LINODE_UPDATE_A_KUBERNETES_CLUSTER` Update a Kubernetes cluster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your `tags` array. | | `label` | string | No | __Filterable__ 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. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `k8s_version` | string | No | The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. New and recycled Nodes in this cluster will be installed with the latest available patch for the Cluster's Kubernetes version. When upgrading the Kubernetes version, only the next latest minor version following the current version can be deployed. For example, a cluster with Kubernetes version 1.29 can be upgraded to version 1.30, but not directly to 1.31. The Kubernetes version of a cluster can not be downgraded. | | `control_plane` | object | No | Defines settings for the Kubernetes control plane, including High Availability (HA) and an IP-based Access Control List (ACL) for the control plane components. When upgrading pre-existing LKE clusters to use the HA Control Plane, the following changes will additionally occur: - All nodes will be deleted and new nodes will be created to replace them. - Any local storage (such as `hostPath` volumes) will be erased. - The upgrade process may take several minutes to complete, as nodes will be replaced on a rolling basis. When upgrading pre-existing LKE clusters to use the control plane ACL for the first time, it may take several hours for external clients to respect the access control settings. This is partly due to delays from DNS propagation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Linode **Slug:** `LINODE_UPDATE_A_LINODE` Update a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ipv4` | array | No | __Filterable__ 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 to get additional IPv4 addresses. IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the networking operations for details. 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 to get additional IPv4 addresses. IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the networking operations for details. | | `tags` | array | No | __Filterable__ Tags to help you organize your content. | | `group` | string | No | __Deprecated__, __Filterable__ The group label for this Linode. | | `label` | string | No | __Filterable__ Provides a name for the Linode. If not provided, the API generates one for it. A Linode label has some constraints: Provides a name for the Linode. If not provided, the API generates one for it. A Linode label has some constraints: - It needs to begin and end with an alphanumeric character. - It can only consist of alphanumeric characters, hyphens (`-`), underscores (`_`), or periods (`.`). - It can't contain two consecutive hyphens (`--`), underscores (`__`) or periods (`..`). | | `alerts` | string | No | Linode request field `alerts`. | | `backups` | object | No | Information about this Linode's backups status. For information about available backups, run List backups. | | `linode_id` | integer | Yes | ID of the Linode to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `watchdog_enabled` | boolean | No | The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and reboots 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 gives up if there have been more than 5 boot jobs issued within 15 minutes. | | `maintenance_policy` | string ("linode/migrate" | "linode/power_off_on") | No | The maintenance policy configured by the user for this Linode. Review maintenance policy documentation for more details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Linode interface **Slug:** `LINODE_UPDATE_A_LINODE_INTERFACE` Update a Linode interface. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `interface_id` | integer | Yes | The `id` of the Linode interface. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Linode's firewalls **Slug:** `LINODE_UPDATE_A_LINODE_S_FIREWALLS` Update a Linode's firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The ID of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_ids` | array | Yes | A complete list of firewall IDs to assign to this Linode or NodeBalancer. This operation replaces any existing assignments. To remove all firewalls, pass an empty list, `[]`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Linode's managed settings **Slug:** `LINODE_UPDATE_A_LINODE_S_MANAGED_SETTINGS` Update a Linode's managed settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ssh` | object | No | The SSH settings for this Linode. | | `linode_id` | integer | Yes | The Linode ID whose settings we are accessing. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Longview plan **Slug:** `LINODE_UPDATE_A_LONGVIEW_PLAN` Update a Longview plan. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `longview_subscription` | string ("longview-3" | "longview-10" | "longview-40" | "longview-100") | No | The subscription ID for a particular Longview plan. A value of `null` corresponds to Longview Free. You can send a request to the List Longview subscriptions operation to receive the details of each plan. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a managed contact **Slug:** `LINODE_UPDATE_A_MANAGED_CONTACT` Update a managed contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of this Contact. | | `email` | string | No | The address to email this Contact to alert them of issues. | | `group` | string | No | __Filterable__ A grouping for this Contact. This is for display purposes only. | | `phone` | object | No | Information about how to reach this Contact by phone. | | `contact_id` | integer | Yes | The ID of the contact to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a managed service monitor **Slug:** `LINODE_UPDATE_A_MANAGED_SERVICE_MONITOR` Update a managed service monitor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | What to expect to find in the response body for the Service to be considered up. | | `label` | string | No | The label for this Service. This is for display purposes only. | | `notes` | string | No | Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues. | | `region` | string | No | The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise. | | `address` | string | No | 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. | | `timeout` | integer | No | How long to wait, in seconds, for a response before considering the Service to be down. | | `service_id` | integer | Yes | The ID of the Managed Service to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `credentials` | array | No | An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service. | | `service_type` | string ("url" | "tcp") | No | How this Service is monitored, either `url` or `tcp`. | | `consultation_group` | string | No | The group of ManagedContacts who should be notified or consulted with when an Issue is detected. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a MySQL Managed Database **Slug:** `LINODE_UPDATE_A_MYSQL_MANAGED_DATABASE` Update a MySQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Request re-sizing of your cluster to a Linode type with more disk space. For example, you could request a Linode type that uses a higher plan. - Needs to be a Linode type with more disk space than your current Linode. - Resizing to a larger Linode type can accrue additional cost. Review the `price` output in the List types operation for more information. - You can't update the `allow_list` and set a new `type` in the same request. - Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update. | | `label` | string | No | __Filterable__ A name used to identify the Managed Database. This needs to be unique per Managed Database `engine` type. For example, you could use `database_1`, `database_2`, and `database_3` for three unique MySQL Managed Databases. You can also use these same names for three unique PostgreSQL Managed Databases. However, you can't repeat any of these names for either engine type. | | `updates` | object | No | Configuration settings for automated patch update maintenance for the Managed Database. | | `version` | string | No | __Filterable__ The Managed Database engine version. | | `allow_list` | array | No | Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database. - An empty array (`[]`) blocks all public and private connections to the Managed Database. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `cluster_size` | integer ("1" | "2" | "3") | No | The number of Linode instance nodes deployed to the Managed Database, from `1` to `3`. Consider these points when setting a `cluster_size`: - Choose `3` nodes to create a high availability cluster that consists of one `primary` node and two `standby` nodes. - A `2` node cluster is only available with a dedicated plan. It consists of one `primary` node and one `standby` node. | | `engine_config` | object | No | Advanced parameters you can apply to a MySQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change. Aiven may offer additional parameters in their specification, or accept different values and ranges. Currently, only the parameters and settings covered here are supported for use in a MySQL Managed Database. You can also run the List MySQL Managed Database advanced parameters operation to see an up-to-date list. | | `private_network` | object | No | Restricts access on a MySQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster. You can only assign VPCs that are in the same region as the database cluster. | | `mysql_instance_id` | integer | Yes | The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an alert definition **Slug:** `LINODE_UPDATE_AN_ALERT_DEFINITION` Update an alert definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `alert_id` | integer | Yes | The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `service_type` | string | Yes | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate `service_type`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an email alert channel **Slug:** `LINODE_UPDATE_AN_EMAIL_ALERT_CHANNEL` Update an alert channel with email-only details; webhook credentials are not accepted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The name of the notification channel for identification purposes. This value needs to be unique for each notification channel. | | `details` | object | No | Configuration settings for an `email` notification channel. | | `channel_id` | integer | Yes | The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an image **Slug:** `LINODE_UPDATE_AN_IMAGE` Update an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ Tags used for organizational purposes. A tag can be from 3 to 100 characters long, and an image can have a maximum of 500 total tags. | | `label` | string | No | __Filterable__ A short description of the image. | | `image_id` | string | Yes | The unique identifier assigned to the image after creation. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A detailed description of this image. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an IP address **Slug:** `LINODE_UPDATE_AN_IP_ADDRESS` Update an IP address. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rdns` | string | No | 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. You can't configure reverse DNS on IP addresses assigned to a NAT Gateway. Attempting to set this field on those addresses returns a 400 error. | | `address` | string | Yes | The address to operate on. | | `reserved` | boolean | No | The `reserved` status of an IPv4 address. - Setting `reserved` to `true` on an ephemeral IP converts it to a reserved IP. - Setting `reserved` to `false` on a reserved IP converts it to an ephemeral IP. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an IP address's RDNS for a Linode **Slug:** `LINODE_UPDATE_AN_IP_ADDRESS_S_RDNS_FOR_A_LINODE` Update an IP address's RDNS for a Linode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rdns` | string | No | 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. | | `address` | string | Yes | The IP address. | | `linode_id` | integer | Yes | The ID of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an object's ACL configuration **Slug:** `LINODE_UPDATE_AN_OBJECT_S_ACL_CONFIGURATION` Update an object's ACL configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `acl` | string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom") | No | The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL. | | `name` | string | No | The name of the object where access control list (ACL) settings will be updated. Run the List Object Storage bucket contents operation to access all object names in a bucket. | | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a node **Slug:** `LINODE_UPDATE_A_NODE` Update a node. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | JSON request body matching the cited Linode operation schema. | | `node_id` | string | Yes | The ID of the Node to access. | | `config_id` | integer | Yes | The ID of the Config to access. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a NodeBalancer **Slug:** `LINODE_UPDATE_A_NODEBALANCER` Update a NodeBalancer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ An array of Tags applied to this object. Tags are for organizational purposes only. | | `label` | string | No | __Filterable__ This NodeBalancer's label. These must be unique on your Account. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | | `client_conn_throttle` | integer | No | Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to `0` (zero) to disable throttling. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a NodeBalancer config **Slug:** `LINODE_UPDATE_A_NODEBALANCER_CONFIG` Update at least one field on a non-TLS TCP, HTTP, or UDP NodeBalancer config. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `port` | integer | No | This is the port the NodeBalancer listens on for this configuration. Port numbers must be unique across TCP, HTTP, and HTTPS configurations on a single NodeBalancer. However, ports assigned to TCP, HTTP, or HTTPS configurations can also be reused for UDP configurations. For example, Port 80 can simultaneously serve a TCP and a UDP configuration on the same NodeBalancer, but it can't be shared by both a TCP and an HTTP configuration. Although certain ports are traditionally assigned specific protocols, this isn't strictly enforced, and you may configure your NodeBalancer however you find useful. | | `check` | string ("none" | "connection" | "http" | "http_body") | No | The type of check to perform against backends to ensure they are serving requests. The `check` is used to determine if backends are up or down. - Setting this to `none` skips the check. - `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. | | `protocol` | string ("tcp" | "http" | "udp") | No | The non-TLS protocol this configuration serves. | | `algorithm` | string ("roundrobin" | "leastconn" | "source") | No | The algorithm this NodeBalancer configuration uses to route traffic to backends. | | `config_id` | integer | Yes | The ID of the Config to access. | | `check_body` | string | No | Use when the active health `check` type is `http_body`. 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. | | `check_path` | string | No | The URL path to check on each backend. Use when the active health `check` type is `http`. If the backend doesn't respond to this request, it's considered to be down. | | `stickiness` | string ("none" | "table" | "http_cookie") | No | 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. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `check_passive` | boolean | No | 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. | | `check_timeout` | integer | No | Number of seconds to wait for a check attempt before considering it failed. Must be less than `check_interval`. | | `check_attempts` | integer | No | How many times to attempt a check before considering a backend to be down. | | `check_interval` | integer | No | Number of seconds between checks to verify that backends are up and serving requests. Must be greater than `check_timeout`. | | `proxy_protocol` | string ("none" | "v1" | "v2") | No | Proxy protocol mode. v1 and v2 require the tcp protocol. | | `udp_check_port` | integer | No | UDP NodeBalancers use TCP and HTTP active health checks to ensure back-end nodes can receive traffic. You can specify the health check port that the backend node listens on, which may differ from the UDP port used to serve traffic. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a NodeBalancer's firewalls **Slug:** `LINODE_UPDATE_A_NODEBALANCER_S_FIREWALLS` Update a NodeBalancer's firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_ids` | array | Yes | A complete list of firewall IDs to assign to this Linode or NodeBalancer. This operation replaces any existing assignments. To remove all firewalls, pass an empty list, `[]`. | | `node_balancer_id` | integer | Yes | The ID of the NodeBalancer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a node pool **Slug:** `LINODE_UPDATE_A_NODE_POOL` Update a node pool. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | __Filterable__ Organizational tags to apply to this node pool. When you apply tags to LKE Enterprise node pools, they also apply to the nodes (Linodes) within the node pool. Tags don't cascade down to nodes in non-Enterprise node pools. | | `count` | integer | No | The number of nodes in the node pool. 🚧 Before you can upgrade an LKE Enterprise node pool's Kubernetes version, adjust this value so that it is at least three nodes for Kubernetes v1.33 (and higher) and at least two nodes for Kubernetes v1.32. The ability to scale node pools to zero nodes is in limited availability and works with LKE Enterprise clusters only. If your account has access to this feature, set `count` to `0` to create a node pool with zero nodes or adjust an existing node pool down to zero nodes. | | `labels` | object | No | Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and easily select subsets of objects. To learn more, review the Labels and taints guide. **Label key:** - A key can contain alphanumeric characters, dashes (`-`), underscores (`_`), or dots (`.`). Start and end it with an alphanumeric character. - If the key begins with a DNS subdomain prefix followed by a single slash, for example `example.com/my-app`, the maximum total length of the label key is 128 characters. Domain labels can be up to 62 characters after the '/'. The prefix needs to adhere to RFC 1123 DNS subdomain restrictions. - If the key doesn't begin with a DNS subdomain prefix, the maximum key length is 63 characters. Specifying an empty object removes all previously set labels. **Label value:** - The label's value can contain alphanumeric characters, dashes (`-`), underscores (`_`), or dots (`.`). Start and end it with an alphanumeric character. - Can be specified as an empty string value with `""`. | | `taints` | array | No | Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. To learn more, review the Labels and taints guide. Specifying an empty array (`[]`) removes all previously set taints. | | `pool_id` | integer | Yes | ID of the Pool to look up. | | `autoscaler` | object | No | When enabled, the number of nodes automatically scales within the defined minimum and maximum values. When making a request, `max` and `min` require each other. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | No | __Beta__, __LKE Enterprise__ The `id` of the Cloud Firewall that you wish to assign to this node pool. Review Recommended firewall settings to learn which rules should be configured within your firewall for compatibility with LKE. If you add, modify, or remove the firewall ID on an existing node pool, you must recycle the node pool to apply the changes. 🚧 This field is available as part of the beta API and can only be used by accounts with access to LKE Enterprise. Call the URL with the `apiVersion` path parameter set to `v4beta`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a placement group **Slug:** `LINODE_UPDATE_A_PLACEMENT_GROUP` Update a placement group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | A unique name for the placement group. A placement group `label` has the following constraints: - It needs to begin and end with an alphanumeric character. - It can only consist of alphanumeric characters, hyphens (`-`), underscores (`_`), or periods (`.`). | | `group_id` | integer | Yes | ID of the placement group to look up. Run the List placement groups operation and store the `id` for the applicable placement group. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a PostgreSQL connection pool **Slug:** `LINODE_UPDATE_A_POSTGRESQL_CONNECTION_POOL` Update a PostgreSQL connection pool. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("session" | "statement" | "transaction") | No | Set the connection pooling mode based on the specification set by our partner, Aiven. Select from `transaction`, `session`, or `statement`. | | `size` | integer | No | The number of connections in the pool. This can't exceed the number of available connections for your service plan. | | `database` | string | No | The name of the PostgreSQL Managed Database where the connection pool is assigned. This is the **Database name** value from connection details. To learn how to get this value, see View connection details. | | `username` | string | No | The username of the client making the connection. The default of `null` reuses the inbound user. | | `pool_name` | string | Yes | The `label` set for a specific connection pool in a PostgreSQL Managed Database. Run the List PostgreSQL connection pools operation and store the `label` for the desired one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a PostgreSQL Managed Database **Slug:** `LINODE_UPDATE_A_POSTGRESQL_MANAGED_DATABASE` Update a PostgreSQL Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Request re-sizing of your cluster to a Linode type with more disk space. For example, you could request a Linode type that uses a higher plan. - Needs to be a Linode type with more disk space than your current Linode. - Resizing to a larger Linode type can accrue additional cost. Review the `price` output from the List types operation for more information. - You can't update the `allow_list` and set a new `type` in the same request. - Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update. | | `label` | string | No | __Filterable__ A name used to identify the Managed Database. This needs to be unique per Managed Database `engine` type. For example, you could use `database_1`, `database_2`, and `database_3` for three unique MySQL Managed Databases. You can also use these same names for three unique PostgreSQL Managed Databases. However, you can't repeat any of these names for either engine type. | | `updates` | object | No | Configuration settings for automated patch update maintenance for the Managed Database. | | `version` | string | No | __Filterable__ The Managed Database engine version. | | `allow_list` | array | No | Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database. - An empty array (`[]`) blocks all public and private connections to the Managed Database. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `cluster_size` | integer ("1" | "2" | "3") | No | The number of Linode instance nodes deployed to the Managed Database, from `1` to `3`. Consider these points when setting a `cluster_size`: - Choose `3` nodes to create a high availability cluster that consists of one `primary` node and two `standby` nodes. - A `2` node cluster is only available with a dedicated plan. It consists of one `primary` node and one `standby` node. | | `engine_config` | object | No | Advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change. Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a PostgreSQL Managed Database. You can also run the List PostgreSQL Managed Database advanced parameters operation to see an up-to-date list. | | `private_network` | object | No | Restricts access on a PostgreSQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster. You can only assign VPCs that are in the same region as the database cluster. | | `postgresql_instance_id` | integer | Yes | The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Rule Set **Slug:** `LINODE_UPDATE_A_RULE_SET` Update a Rule Set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | __Filterable__ Unique, user-defined label for this Rule Set. This label helps you identify and describe your Rule Set. | | `rules` | array | No | The inbound or outbound access rules for the Rule Set. A Rule Set can have a total of 25 inbound and outbound rules. Multiple rules are applied in order. If two rules conflict, the first rule takes precedence. For example, if the first rule accepts inbound traffic from an address, and the second rule drops inbound traffic from the same address, the first rule applies, and inbound traffic from that address is accepted. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | Describes this Rule Set. For display purposes only. | | `rule_set_id` | integer | Yes | ID of the Rule Set to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a shared image **Slug:** `LINODE_UPDATE_A_SHARED_IMAGE` Update a shared image. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The shared image's descriptive name. | | `image_id` | string | Yes | Slug identifier assigned to the shared image upon sharing. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A detailed description of this image share. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a share group **Slug:** `LINODE_UPDATE_A_SHARE_GROUP` Update a share group. This operation is available only through Linode API v4beta. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The share group's descriptive name. | | `api_version` | string | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A detailed description of this share group. | | `sharegroup_id` | integer | Yes | The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a StackScript **Slug:** `LINODE_UPDATE_A_STACKSCRIPT` Update a StackScript. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | __Filterable__ The StackScript's label is for display purposes only. | | `images` | array | No | 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. | | `script` | string | No | The script to execute when provisioning a new Linode with this StackScript. | | `rev_note` | string | No | __Filterable__ This field allows you to add notes for the set of revisions made to this StackScript. | | `is_public` | boolean | No | __Filterable__ This determines whether other users can use your StackScript. __Once a StackScript is made public, it cannot be made private.__ | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | __Filterable__ A description for the StackScript. | | `stackscript_id` | string | Yes | The ID of the StackScript to look up. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a stream **Slug:** `LINODE_UPDATE_A_STREAM` Update a stream. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | The name of the stream. This is used for display purposes in Akamai Cloud Manager. | | `status` | string ("active" | "inactive") | No | The availability status of the stream. This can be `active` or `inactive`. | | `details` | object | No | Additional details for the stream, based on its `type`. To view your current `type`, run the Get a stream to target your specific stream. Consider these points when updating a stream: - This object only applies to streams with a `type` of `lke_audit_logs`. Leave it out of requests that use a `type` of `audit_logs`. - Any existing settings need to be included to maintain them. For example, if you're adding new `cluster_ids` to the stream, you also need to include any existing ones to maintain them. Run the Get a stream operation to review the existing `details` settings for a stream. - You can't change the `type` of an existing stream. | | `stream_id` | integer | Yes | The unique identifier assigned to the stream. Run the List streams operation and store the `id` for the applicable one. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `destinations` | array | No | The unique identifier for a new sync point to receive logs data. Run the List destinations operation and store the `id` value for the applicable destination. Currently, you can only specify a single destination for a stream. If you include a value in this array, it will overwrite an existing destination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a user's access level **Slug:** `LINODE_UPDATE_A_USER_S_ACCESS_LEVEL` Update a user's access level. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `username` | string | Yes | The username to look up. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `entity_access` | array | Yes | Encapsulates assigned entity access roles and entities they apply to. | | `account_access` | array | Yes | Assigned account access roles. For a list of available account access roles and their included permissions, see Available roles. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Valkey Managed Database **Slug:** `LINODE_UPDATE_A_VALKEY_MANAGED_DATABASE` Update a Valkey Managed Database. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Request re-sizing of your cluster to a Linode type with more disk space. For example, you could request a Linode type that uses a higher plan. - Needs to be a Linode type with more disk space than your current Linode. - Resizing to a larger Linode type can accrue additional cost. Review the `price` output from the List types operation for more information. - You can't update the `allow_list` and set a new `type` in the same request. - Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update. | | `label` | string | No | __Filterable__ A name used to identify the Managed Database. This needs to be unique per Managed Database `engine` type. For example, you could use `database_1`, `database_2`, and `database_3` for three unique MySQL Managed Databases. You can also use these same names for three unique PostgreSQL Managed Databases. However, you can't repeat any of these names for either engine type. | | `region` | string | No | __Filterable__ The unique identifier for the region where the Managed Database lives. | | `updates` | object | No | Configuration settings for automated patch update maintenance for the Managed Database. | | `version` | string | No | __Filterable__ The Managed Database engine version. | | `allow_list` | array | No | Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database. - An empty array (`[]`) blocks all public and private connections to the Managed Database. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `cluster_size` | integer ("1" | "2" | "3") | No | The number of Linode instance nodes deployed to the Managed Database, from `1` to `3`. Consider these points when setting a `cluster_size`: - Choose `3` nodes to create a high availability cluster that consists of one `primary` node and two `standby` nodes. - A `2` node cluster is only available with a dedicated plan. It consists of one `primary` node and one `standby` node. | | `engine_config` | object | No | Advanced parameters applied to a Valkey Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change. Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a Valkey Managed Database. You can also run the Get Valkey Managed Database advanced parameters operation to see an up-to-date list. | | `private_network` | object | No | Restricts access on a Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster. Displayed as `null` if no VPC is configured. | | `valkey_instance_id` | integer | Yes | The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the `id` for the desired one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a volume **Slug:** `LINODE_UPDATE_A_VOLUME` Update a volume. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Any tags applied to this object. Use tags to label and organize your cloud computing resources. | | `label` | string | No | The name of the volume. A `label` can be up to 32 characters long and contain alphanumeric characters, dashes, and underscores. This value is also used in the volume's `filesystem_path`. | | `volume_id` | integer | Yes | The unique identifier for the target volume. Run the List volumes operation and store the `id` for the target volume as your `volumeId`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a VPC **Slug:** `LINODE_UPDATE_A_VPC` Update a VPC. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ipv4` | array | No | The IPv4 ranges belonging to this VPC. - When creating a VPC, if `ipv4` is `null` or omitted, the system applies the VPC's default ranges. - When updating a VPC, if `ipv4` is `null` or omitted, existing ranges remain unchanged. - If provided, the array must contain at least one range. - A single VPC can be configured with a maximum of 30 distinct IPv4 ranges. - Ranges can be defined with a prefix length anywhere from `/5` to `/30`. - Ranges must be unique and must not overlap with restricted ranges defined in `forbidden_ipv4_ranges`. - Ranges must be provided in canonical format with no host bits set. For example, `10.0.0.0/8` is valid, but `10.1.0.0/8` is rejected. - Ranges must be fully aggregated. Overlapping ranges or sub-ranges already contained within a larger prefix are not allowed. For example, you can't provide both `10.0.0.0/8` and `10.1.0.0/24`. - All subnet ranges must be contained within these VPC IPv4 ranges. - Changing the ranges for a VPC with Linodes is subject to a 15 minute cooldown measured from the last VPC update. | | `label` | string | No | __Filterable__ The VPC's label, for display purposes only. - Needs to be unique among the Account's VPCs. - Can only contain ASCII letters, numbers, and hyphens (`-`). You can't use two consecutive hyphens (`--`). | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `description` | string | No | A written description to help distinguish the VPC. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a VPC subnet **Slug:** `LINODE_UPDATE_A_VPC_SUBNET` Update a VPC subnet. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | __Filterable__ The VPC subnet's unique label that is used as an identifier for the VPC subnet. - Must be unique among the VPC's subnets. - Can only contain alphanumeric characters and non-consecutive dashes (`-`). | | `vpc_id` | integer | Yes | The `id` of the VPC. | | `natgateway` | integer | No | The unique identifier of the attached NAT Gateway instance. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `vpc_subnet_id` | integer | Yes | The `id` of the VPC Subnet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update CORS access to an Object Storage bucket (E0/E1) **Slug:** `LINODE_UPDATE_CORS_ACCESS_TO_AN_OBJECT_STORAGE_BUCKET_E0_E1` Update CORS access to an Object Storage bucket (E0/E1). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `acl` | string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom") | No | The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL. | | `bucket` | string | Yes | The bucket name. | | `region_id` | string | Yes | Identifies a region where this bucket lives. You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `cors_enabled` | boolean | No | Whether cross-origin resource sharing (CORS) is enabled for all origins on the bucket. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update default firewalls **Slug:** `LINODE_UPDATE_DEFAULT_FIREWALLS` Update default firewalls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `default_firewall_ids` | object | No | The default firewall ID for a `linode`, `nodebalancer`, `public_interface`, or `vpc_interface`. Default firewalls can't be deleted or disabled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update firewall rules **Slug:** `LINODE_UPDATE_FIREWALL_RULES` Update firewall rules. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | JSON request body matching the cited Linode operation schema. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `firewall_id` | integer | Yes | ID of the Firewall to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Linode interface settings **Slug:** `LINODE_UPDATE_LINODE_INTERFACE_SETTINGS` Update Linode interface settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `default_route` | object | No | Interfaces used for the IPv4 `default_route` and IPv6 `default_route` when multiple interfaces are eligible for the role. | | `network_helper` | boolean | No | Enables the Network Helper feature. The default value is determined by the `network_helper` setting in the account settings. Power off the Linode before disabling or enabling Network Helper. | | `allow_disruptive_networking_changes` | string ("default" | "true") | No | Bypasses the internal shutdown check during live network interface reconfigurations when Network Helper is enabled. - `default`. Maintains standard behavior. If `network_helper` is set to `true`, updating interface configurations on a running Linode requires a shutdown. - `on`. Allows interface reconfigurations while the Linode is running, even if `network_helper` is enabled. Changing `network_helper` from `false` to `true` on a running Linode still requires a shutdown regardless of this setting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update NAT Gateway label **Slug:** `LINODE_UPDATE_NAT_GATEWAY_LABEL` Update NAT Gateway label. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | Yes | __Filterable__ The NAT Gateway's label, for display purposes only. - Needs to be unique among the account's NAT Gateways. - Can only contain ASCII letters, numbers, and dashes (`-`). You can't use two consecutive dashes (`--`). | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `natgateway_id` | integer | Yes | ID of the NAT Gateway to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update reserved IP address tags **Slug:** `LINODE_UPDATE_RESERVED_IP_ADDRESS_TAGS` Update reserved IP address tags. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | Yes | Tags to apply to this reserved IP that match existing tags. This operation performs a full replacement of existing tags. The tags in the request body will overwrite all current tags associated with the reserved IP. To maintain existing tags, they must be included in the update request. | | `address` | string | Yes | The reserved address to update, view, or delete. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update SSO-required users **Slug:** `LINODE_UPDATE_SSO_REQUIRED_USERS` Update SSO-required users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `usernames` | array | Yes | The usernames to set for the SSO user exceptions or SSO-required lists. Pass an empty array to clear the list. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `idp_config_id` | string | Yes | The unique identifier of the external identity provider configuration. This is the `id` value returned by the List IDP configurations operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update SSO user exceptions **Slug:** `LINODE_UPDATE_SSO_USER_EXCEPTIONS` Update SSO user exceptions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `usernames` | array | Yes | The usernames to set for the SSO user exceptions or SSO-required lists. Pass an empty array to clear the list. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `idp_config_id` | string | Yes | The unique identifier of the external identity provider configuration. This is the `id` value returned by the List IDP configurations operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update the account delegation for a child account **Slug:** `LINODE_UPDATE_THE_ACCOUNT_DELEGATION_FOR_A_CHILD_ACCOUNT` Update the account delegation for a child account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `euuid` | string | Yes | A unique identifier for a child account. To get this value, run List child accounts. | | `users` | array | No | Usernames to add to the account delegation for the child account. | | `api_version` | string | No | __Enum__ Call the `v4` URL. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update the control plane access control list **Slug:** `LINODE_UPDATE_THE_CONTROL_PLANE_ACCESS_CONTROL_LIST` Update the control plane access control list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `acl` | object | No | Defines settings related to the IP-based ACL of the LKE cluster. The object requires the `enabled` and `addresses` keys. It also supports the optional key `revision-id`. The default policy is set to `ALLOW`, so that access controls are disabled. An empty object value (`{}`) sets default elements. | | `cluster_id` | integer | Yes | ID of the Kubernetes cluster to look up. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update the default role assignment for delegate users **Slug:** `LINODE_UPDATE_THE_DEFAULT_ROLE_ASSIGNMENT_FOR_DELEGATE_USERS` Update the default role assignment for delegate users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_version` | string | No | __Enum__ Call the `v4` URL. | | `entity_access` | array | Yes | Encapsulates assigned entity access roles and entities they apply to. | | `account_access` | array | Yes | Assigned account access roles. For a list of available account access roles and their included permissions, see Available roles. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update your account **Slug:** `LINODE_UPDATE_YOUR_ACCOUNT` Update your account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | The zip code for this account's `address`. - It can only contain ASCII letters, numbers, and dashes (`-`). - It can't contain more than nine letter or number characters. | | `city` | string | No | The city for this account's `address`. | | `email` | string | No | The email address of the person assigned to this account. | | `phone` | string | No | The phone number assigned to this account. | | `state` | string | No | The state or province for the `address` set for your account, if applicable. - If the `address` is in the United States (US) or Canada (CA), this is the two-letter ISO 3166 code for the state or province. - If it's a US military `address`, this is the abbreviation for that territory. This includes `AA` for Armed Forces Americas (excluding Canada), `AE` for Armed Forces Africa, Europe, Middle East, and Canada, or `AP` for Armed Forces Pacific. - If outside the US or CA, this is the province associated with the account's `address`. | | `tax_id` | string | No | The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`""`) if a TIN doesn't apply or for countries that don't collect tax. This value is externally validated. If the validation is successful, a `tax_id_valid` event is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it. | | `company` | string | No | The company name assigned to this account. This value can't include the characters, `<` `>` `(` `)` `"` `=`. | | `country` | string | No | The two-letter ISO 3166 country code for this account's `address`. | | `address_1` | string | No | The first line of this account's billing address. | | `address_2` | string | No | The second line of this account's billing address. | | `last_name` | string | No | The last name of the person assigned to this account. This value can't include the characters, `<` `>` `(` `)` `"` `=`. | | `first_name` | string | No | The first name of the person assigned to this account. This value can't include the characters, `<` `>` `(` `)` `"` `=`. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upgrade a Linode **Slug:** `LINODE_UPGRADE_A_LINODE` Upgrade a Linode. This operation is destructive and may be irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `linode_id` | integer | Yes | ID of the Linode to mutate. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | | `allow_auto_disk_resize` | boolean | No | Automatically resize disks when resizing a Linode. When resizing down to a smaller plan your Linode's data must fit within the smaller disk size. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upgrade to Linode interfaces **Slug:** `LINODE_UPGRADE_TO_LINODE_INTERFACES` Irreversibly upgrade legacy configuration interfaces to Linode interfaces. This changes the Linode's interfaces and removes all legacy config interfaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config_id` | integer | No | The Linode's `config_id`. Only one `config_id` can be specified: - If there are no legacy configuration interfaces or configurations defined in the config_id, a public interface is created using the Linode's automatically assigned public IPv4 address. - If a config_id is not provided and the Linode has only one configuration, the upgrade automatically uses that config_id. - If the Linode has multiple configurations and a config_id is not specified, an error is returned. | | `linode_id` | integer | Yes | The `id` of the Linode. | | `api_version` | string ("v4" | "v4beta") | No | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |