Skip to main content
Linode logo
  • Category: it operations
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 418
  • Triggers: 0
  • Slug: LINODE
  • Version: 00000000_00

Tools

Slug: LINODE_ACKNOWLEDGE_AGREEMENTSAcknowledge agreements. This operation is destructive and may be irreversible.

Input Parameters

boolean
The acknowledgement status for the cross-border data transfer agreement.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
The acknowledgement status for Akamai’s privacy statement.
boolean
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.
boolean
The acknowledgement status for Akamai’s master service agreement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ADD_A_CONFIGURATION_PROFILE_INTERFACEAdd a configuration profile interface.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ADD_A_LINODE_INTERFACEAdd a Linode interface.

Input Parameters

string
JSON request body matching the cited Linode operation schema.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ADD_A_NAT_GATEWAY_IP_ADDRESSAdd a NAT Gateway IP address.

Input Parameters

string
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ADD_IMAGES_TO_A_SHARE_GROUPAdd images to a share group. This operation is available only through Linode API v4beta.

Input Parameters

array
Linode request field images.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ALLOCATE_AN_IP_ADDRESSAllocate an IP address. This operation is destructive and may be irreversible.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ALLOCATE_AN_IPV4_ADDRESSAllocate an IPv4 address.

Input Parameters

string
required
The type of address you are allocating. Only IPv4 addresses may be allocated through this operation.
boolean
required
Whether to create a public or private IPv4 address.
string
An optional unassigned reserved IP address to be assigned to this Linode. If omitted, a new non-reserved IP address is allocated.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ALLOW_CORS_ACCESS_TO_AN_OBJECT_STORAGE_BUCKET_E0_E1Allow CORS access to an Object Storage bucket (E0/E1).

Input Parameters

string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom")
The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.
string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
Whether cross-origin resource sharing (CORS) is enabled for all origins in the bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_APPLY_A_LINODE_S_FIREWALLSApply a Linode’s firewalls.

Input Parameters

integer
required
The ID of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ASSIGN_A_PLACEMENT_GROUPAssign a placement group.

Input Parameters

array
The linodeId values for individual Linodes included in the placement group.
integer
required
ID of the placement group to look up. Run the List placement groups operation and store the id for the applicable placement group.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ASSIGN_IP_ADDRESSESAssign IP addresses. This operation is destructive and may be irreversible.

Input Parameters

string
required
The ID of the region in which these assignments are to take place. All IPs and Linodes must exist in this region.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ASSIGN_IPV4S_TO_LINODESAssign IPv4s to Linodes. This operation is destructive and may be irreversible.

Input Parameters

string
required
The ID of the region in which these assignments are to take place. All IPs and Linodes must exist in this region.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ATTACH_A_VOLUMEAttach a volume.

Input Parameters

integer
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.
integer
required
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.
integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_BOOT_A_LINODEBoot a Linode.

Input Parameters

integer
The Linode Config ID to boot into.
integer
required
The ID of the Linode to boot.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_BOOT_A_LINODE_INTO_RESCUE_MODEBoot a Linode into rescue mode.

Input Parameters

object
Linode request field devices.
integer
required
ID of the Linode to rescue.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CANCEL_BACKUPSCancel backups. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Linode to cancel backup service for.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CANCEL_OBJECT_STORAGECancel Object Storage. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLONE_A_DISKClone a disk.

Input Parameters

integer
required
ID of the Disk to clone.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLONE_A_DOMAINClone a domain.

Input Parameters

string
required
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.
integer
required
ID of the Domain to clone.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLONE_A_LINODEClone a Linode.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
ID of the Linode to clone.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLONE_AN_ALERT_DEFINITIONClone an alert definition.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLONE_A_VOLUMEClone a volume.

Input Parameters

string
required
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.
integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CLOSE_A_SUPPORT_TICKETClose a support ticket.

Input Parameters

integer
required
The ID of the support ticket.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CONFIGURE_IPV4_SHARINGConfigure IPv4 sharing.

Input Parameters

array
required
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.
integer
required
The ID of the primary Linode that the addresses will be shared with.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_CONFIGURATION_PROFILECreate a configuration profile.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
ID of the Linode to look up Configuration profiles for.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_DOMAINCreate a domain.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_DOMAIN_RECORDCreate a domain record.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The ID of the Domain we are accessing Records for.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_FIREWALLCreate a firewall.

Input Parameters

object
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_FIREWALL_DEVICECreate a firewall device.

Input Parameters

object
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_KUBERNETES_CLUSTERCreate a Kubernetes cluster. This operation may provision billable resources and incur Linode charges.

Input Parameters

array
Filterable An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
string ("standard" | "enterprise")
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.
string
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.
string
Filterable This Kubernetes cluster’s location.
integer
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.
integer
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.
array
The node pools to create for this Kubernetes cluster. Each node pool is a group of nodes (Linodes) with the same configuration.
string ("ipv4" | "ipv4-ipv6")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
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.
string
Filterable The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. The latest supported patch version is deployed.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_MANAGED_CONTACTCreate a managed contact.

Input Parameters

string
The name of this Contact.
string
The address to email this Contact to alert them of issues.
string
Filterable A grouping for this Contact. This is for display purposes only.
object
Information about how to reach this Contact by phone.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_MANAGED_SERVICECreate a managed service.

Input Parameters

object
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_ALERT_DEFINITIONCreate an alert definition.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_NAT_GATEWAYCreate a NAT Gateway.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_EMAIL_ALERT_CHANNELCreate an email-only Monitor alert channel; webhook credentials are not accepted.

Input Parameters

string
The name of the notification channel for identification purposes. This value needs to be unique for each notification channel.
object
required
Configuration settings for an email notification channel.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
Create an email notification channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_EMPTY_DISKCreate an empty disk without deploying an image or login credentials.

Input Parameters

integer
required
Filterable The size of the disk in MB. Images require a minimum size. Run the Get an image operation to view its size.
string
required
Filterable The name of the disk. This is for display purposes only.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_EMPTY_LINODECreate a billable empty offline Linode without an image, disks, or login access.

Input Parameters

array
Filterable Tags to help you organize your content.
string
required
The Linode type of the Linode you’re creating.
string
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 (..).
string
required
The region where the Linode will be located.
boolean
If true, the created Linode will have private networking enabled and assigned a private IPv4 address.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
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.
object
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.
string ("legacy_config" | "linode")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_IMAGECreate an image.

Input Parameters

array
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.
string
The short title for this image. If not provided, the disk’s current label is used.
integer
The ID of the target Linode disk for this image.
boolean
Whether this image supports cloud-init.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A detailed description of this image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_IPV6_RANGECreate an IPv6 range.

Input Parameters

integer
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
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.
integer ("56" | "64")
required
The prefix length of the IPv6 range, either 56 or 64.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_AN_OBJECT_STORAGE_BUCKETCreate an Object Storage bucket. This operation may provision billable resources and incur Linode charges.

Input Parameters

string ("private" | "public-read" | "authenticated-read" | "public-read-write")
The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.
string
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.
string
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
The active user’s S3-compatible endpoint URL, based on the endpoint_type and region.
boolean
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.
string ("E0" | "E1" | "E2" | "E3")
The type of s3_endpoint available to the active user in this region. See Endpoint types for more information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_NODECreate a node.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The ID of the NodeBalancer config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_NODEBALANCERCreate a billable NodeBalancer without a listening configuration.

Input Parameters

string
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.
array
An array of Tags applied to this object. Tags are for organizational purposes only.
string ("common" | "premium")
The type of NodeBalancer.
array
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.
string
Filterable This NodeBalancer’s label. These must be unique on your Account.
string
required
The ID of the Region to create this NodeBalancer in.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
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.
string ("legacy" | "ipv6" | "vpc")
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.
integer
Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_NODEBALANCER_CONFIGCreate a non-TLS TCP, HTTP, or UDP NodeBalancer config without inline nodes.

Input Parameters

integer
required
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.
string ("none" | "connection" | "http" | "http_body")
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.
string ("tcp" | "http" | "udp")
required
The non-TLS protocol this configuration serves.
string ("roundrobin" | "leastconn" | "source")
The algorithm this NodeBalancer configuration uses to route traffic to backends.
string
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.
string
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.
string ("none" | "table" | "http_cookie")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
integer
How long, in seconds, to wait for a check attempt before considering it failed. Must be less than check_interval.
integer
How many times to attempt a check before considering a backend to be down.
integer
How often, in seconds, to check that backends are up and serving requests. Must be greater than check_timeout.
string ("none" | "v1" | "v2")
Proxy protocol mode. v1 and v2 require the tcp protocol.
integer
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.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_NODE_POOLCreate a node pool.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_PLACEMENT_GROUPCreate a placement group.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_POSTGRESQL_CONNECTION_POOLCreate a PostgreSQL connection pool.

Input Parameters

string ("session" | "statement" | "transaction")
required
Set the connection pooling mode based on the specification set by our partner, Aiven. Select from transaction, session, or statement.
integer
required
The number of connections in the pool. This can’t exceed the number of available connections for your service plan.
string
required
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.
string
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.
string
required
The username of the client making the connection. The default of null reuses the inbound user.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_REPLYCreate a reply.

Input Parameters

integer
required
The ID of the support ticket.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The content of your reply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_RESOURCE_LOCKCreate a resource lock.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string
Enum Call the v4beta URL for operations still only in beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_RULE_SETCreate a Rule Set.

Input Parameters

string ("inbound" | "outbound")
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.
string
Filterable Unique, user-defined label for this Rule Set. This label helps you identify and describe your Rule Set.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
Describes this Rule Set. For display purposes only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_SHARE_GROUPCreate a share group. This operation is available only through Linode API v4beta.

Input Parameters

string
The share group’s descriptive name.
array
A list of image’s details, including the ID, label, and description.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A detailed description of this share group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_SNAPSHOTCreate a snapshot.

Input Parameters

string
required
The label for the new snapshot.
integer
required
The ID of the Linode the backups belong to.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_STACKSCRIPTCreate a StackScript.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_STREAMCreate a stream.

Input Parameters

string ("audit_logs" | "lke_audit_logs")
required
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.
string
required
The name of the stream. This is used for display purposes in Akamai Cloud Manager.
string ("active" | "inactive")
The availability status of the stream. This can be active or inactive.
object
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_SUPPORT_TICKET_ATTACHMENTCreate a support ticket attachment.

Input Parameters

object
required
The local, absolute path to the file you want to attach to your support ticket.
integer
required
The ID of the support ticket.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_TAGCreate a tag.

Input Parameters

string
The name of your tag. This is used for display purposes.
array
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.
array
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.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_VOLUMECreate a volume. This operation may provision billable resources and incur Linode charges.

Input Parameters

integer
The initial size of this volume, in GB. Volumes can only be resized after the creation completes.
array
Filterable Any tags applied to this object. Use tags to label and organize your cloud computing resources.
string
required
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.
string
The region where the API deploys the volume. This is only required if you didn’t provide a linode_id for the volume.
integer
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.
integer
The Linode this volume should be attached to after it’s created. If not given, the volume will be created without an attachment.
string ("enabled" | "disabled")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_VPCCreate a VPC.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_A_VPC_SUBNETCreate a VPC subnet.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_OR_RESTORE_A_MYSQL_MANAGED_DATABASECreate or restore a MySQL Managed Database. This operation may provision billable resources and incur Linode charges.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_OR_RESTORE_A_POSTGRESQL_MANAGED_DATABASECreate or restore a PostgreSQL Managed Database. This operation may provision billable resources and incur Linode charges.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_CREATE_OR_RESTORE_A_VALKEY_MANAGED_DATABASECreate or restore a Valkey Managed Database. This operation may provision billable resources and incur Linode charges.

Input Parameters

string
required
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_CONFIGURATION_PROFILEDelete a configuration profile. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_CONFIGURATION_PROFILE_INTERFACEDelete a configuration profile interface. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode Configuration Profile Interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_DISKDelete a disk. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Disk to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_DOMAINDelete a domain. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Domain to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_DOMAIN_RECORDDelete a domain record. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Domain whose Record you are accessing.
integer
required
The ID of the Record you are accessing.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_FIREWALLDelete a firewall. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_FIREWALL_DEVICEDelete a firewall device. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Firewall Device to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_KUBERNETES_CLUSTERDelete a Kubernetes cluster. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_LINODEDelete a Linode. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_LINODE_INTERFACEDelete a Linode interface. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_MANAGED_CONTACTDelete a managed contact. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the contact to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_MANAGED_SERVICE_MONITORDelete a managed service monitor. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Managed Service to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_MYSQL_MANAGED_DATABASEDelete a MySQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_AN_ALERT_DEFINITIONDelete an alert definition. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NAT_GATEWAYDelete a NAT Gateway. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_AN_IMAGEDelete an image. This operation is destructive and may be irreversible.

Input Parameters

string
required
The unique identifier assigned to the image after creation.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_AN_IPV4_ADDRESSDelete an IPv4 address. This operation is destructive and may be irreversible.

Input Parameters

string
required
The IP address.
integer
required
The ID of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_AN_IPV6_RANGEDelete an IPv6 range. This operation is destructive and may be irreversible.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NODEDelete a node. This operation is destructive and may be irreversible.

Input Parameters

string
required
The ID of the Node to access.
integer
required
ID of the Kubernetes cluster containing the Node.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NODEBALANCERDelete a NodeBalancer. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NODEBALANCER_CONFIGPermanently delete a NodeBalancer config. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NODEBALANCER_S_NODEDelete a NodeBalancer’s node. This operation is destructive and may be irreversible.

Input Parameters

string
required
The ID of the Node to access.
integer
required
The ID of the Config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NODE_POOLDelete a node pool. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Pool to look up.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_NOTIFICATION_CHANNELDelete a notification channel. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_PLACEMENT_GROUPDelete a placement group. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the placement group to look up. Run the List placement groups operation and store the id for the applicable placement group.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_POSTGRESQL_CONNECTION_POOLDelete a PostgreSQL connection pool. This operation is destructive and may be irreversible.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_POSTGRESQL_MANAGED_DATABASEDelete a PostgreSQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_RESOURCE_LOCKDelete a resource lock. This operation is destructive and may be irreversible.

Input Parameters

string
Enum Call the v4beta URL for operations still only in beta.
integer
required
The unique identifier assigned to the resource lock. Run the List resource locks operation and store the id for the applicable resource lock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_RULE_SETDelete a Rule Set. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Rule Set to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_SHARE_GROUPDelete a share group. This operation is available only through Linode API v4beta. This operation is destructive and may be irreversible.

Input Parameters

string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_STACKSCRIPTDelete a StackScript. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The ID of the StackScript to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_STREAMDelete a stream. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The unique identifier assigned to the stream. Run the List streams operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_TAGDelete a tag. This operation is destructive and may be irreversible.

Input Parameters

string
required
The label of the tag to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_VALKEY_MANAGED_DATABASEDelete a Valkey Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_VLANDelete a VLAN. This operation is destructive and may be irreversible.

Input Parameters

string
required
The label of the VLAN to be deleted.
string
required
The VLAN’s region.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_VOLUMEDelete a volume. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_VPCDelete a VPC. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_A_VPC_SUBNETDelete a VPC subnet. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the VPC Subnet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DELETE_THE_CONTROL_PLANE_ACCESS_CONTROL_LISTDelete the control plane access control list. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DETACH_A_VOLUMEDetach a volume. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_DISABLE_A_MANAGED_SERVICE_MONITORDisable a managed service monitor. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The ID of the Managed Service to disable.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ENABLE_A_MANAGED_SERVICE_MONITOREnable a managed service monitor.

Input Parameters

integer
required
The ID of the Managed Service to enable.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ENABLE_BACKUPSEnable backups. This operation may provision billable resources and incur Linode charges.

Input Parameters

integer
required
The ID of the Linode to enable backup service for.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ENABLE_LINODE_MANAGEDEnable Linode Managed. This operation may provision billable resources and incur Linode charges.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_ENROLL_IN_A_BETA_PROGRAMEnroll in a Beta program.

Input Parameters

string
required
The unique identifier for the Beta program.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_BACKUPGet a backup.

Input Parameters

integer
required
The ID of the Backup to look up.
integer
required
The ID of the Linode the Backup belongs to.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_BETA_PROGRAMGet a Beta program.

Input Parameters

string
required
The unique identifier for the Beta program.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_BUCKET_S_TLS_SSL_CERTIFICATEGet a bucket’s TLS/SSL certificate.

Input Parameters

string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_ACCOUNT_SUMMARYReturn billing status, current balance, promotions, and enabled cloud capabilities for the connected Linode account, excluding contact and payment-card details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_CHILD_ACCOUNTGet a child account.

Input Parameters

string
required
A unique identifier for a child account. To get this value, run List child accounts.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_CONFIGGet a config.

Input Parameters

integer
required
The ID of the Config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_CONFIGURATION_PROFILEGet a configuration profile.

Input Parameters

integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_CONFIGURATION_PROFILE_INTERFACEGet a configuration profile interface.

Input Parameters

integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode Configuration Profile Interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_DASHBOARDGet a dashboard.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_DISKGet a disk.

Input Parameters

integer
required
ID of the Disk to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_DOMAINGet a domain.

Input Parameters

integer
required
The ID of the Domain to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_DOMAIN_RECORDGet a domain record.

Input Parameters

integer
required
The ID of the Domain whose Record you are accessing.
integer
required
The ID of the Record you are accessing.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_DOMAIN_ZONE_FILEGet a domain zone file.

Input Parameters

string
required
ID of the Domain.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_FIREWALLGet a firewall.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_FIREWALL_DEVICEGet a firewall device.

Input Parameters

integer
required
ID of the Firewall Device to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_FIREWALL_RULE_VERSIONGet a firewall rule version.

Input Parameters

integer
required
The firewall rule version to view.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_FIREWALL_TEMPLATEGet a firewall template.

Input Parameters

string ("vpc" | "public")
required
Enum The firewall template type, available for either vpc or public interfaces.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_KERNELGet a kernel.

Input Parameters

string
required
ID of the Kernel to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_KUBERNETES_CLUSTERGet a Kubernetes cluster.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LINODEGet a Linode.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LINODE_INTERFACEGet a Linode interface.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LINODE_S_IP_ADDRESSGet a Linode’s IP address.

Input Parameters

string
required
The IP address.
integer
required
The ID of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LINODE_S_MANAGED_SETTINGSGet a Linode’s managed settings.

Input Parameters

integer
required
The Linode ID whose settings we are accessing.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LONGVIEW_PLANGet a Longview plan.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_LONGVIEW_SUBSCRIPTIONGet a Longview subscription.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string ("longview-3" | "longview-10" | "longview-40" | "longview-100")
required
Enum The Longview Subscription to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MANAGED_CONTACTGet a managed contact.

Input Parameters

integer
required
The ID of the contact to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MANAGED_DATABASES_ENGINEGet a Managed Databases engine.

Input Parameters

string
required
The ID of the Managed Database engine. To get this value, run the List Managed Databases engines operation.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MANAGED_DATABASES_TYPEGet a Managed Databases type.

Input Parameters

string
required
The ID of the Managed Database type.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MANAGED_ISSUEGet a managed issue.

Input Parameters

integer
required
The Issue to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MANAGED_SERVICE_MONITORGet a managed service monitor.

Input Parameters

integer
required
The ID of the Managed Service to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MONTH_S_LINODE_STATISTICSGet a month’s Linode statistics.

Input Parameters

integer
required
Numeric value representing the year to look up.
integer
required
Numeric value representing the month to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MYSQL_MANAGED_DATABASEGet a MySQL Managed Database.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_MYSQL_MANAGED_DATABASE_SSL_CERTIFICATEGet a MySQL Managed Database SSL certificate.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_ACCOUNT_LOGINGet an account login.

Input Parameters

integer
required
The ID of the login object to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_ALERT_DEFINITIONGet an alert definition.

Input Parameters

integer
required
The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NAT_GATEWAYGet a NAT Gateway.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NAT_GATEWAY_IP_ADDRESSGet a NAT Gateway IP address.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.
string
required
A public IPv4 NAT Gateway address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_ENROLLED_BETA_PROGRAMGet an enrolled Beta program.

Input Parameters

string
required
The unique identifier for the Beta program.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_EVENTGet an event.

Input Parameters

integer
required
The ID of the Event.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_IMAGEGet an image.

Input Parameters

string
required
The unique identifier assigned to the image after creation.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_INVOICEGet an invoice.

Input Parameters

integer
required
The ID of the Invoice.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_IP_ADDRESSGet an IP address.

Input Parameters

string
required
The address to operate on.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_IPV6_RANGEGet an IPv6 range.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_LKE_KUBERNETES_VERSION_ANY_TIERGet an LKE Kubernetes version (any tier).

Input Parameters

string ("standard" | "enterprise")
required
Enum The LKE tier to use.
string
required
The LKE version to view.
string
Enum Call the v4beta URL for operations still only in beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_LKE_KUBERNETES_VERSION_NON_ENTERPRISEGet an LKE Kubernetes version (non-enterprise).

Input Parameters

string
required
The LKE version to view.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_OBJECT_STORAGE_BUCKETGet an Object Storage bucket.

Input Parameters

string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_OBJECT_STORAGE_GLOBAL_QUOTAGet an Object Storage global quota.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
Enum Identifies the Object Storage-related global quota to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_OBJECT_STORAGE_OBJECT_ACL_CONFIGURATIONGet an Object Storage object ACL configuration.

Input Parameters

string
required
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.
string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AN_OBJECT_STORAGE_QUOTAGet an Object Storage quota.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
Identifies the Object Storage-related global quota to retrieve. This follows the pattern, <quota_type>-<s3_endpoint>, for example, buckets-eu-central-1.linodeobjects.com.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NODEGet a node.

Input Parameters

string
required
The ID of the Node to access.
integer
required
ID of the Kubernetes cluster containing the Node.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NODEBALANCERGet a NodeBalancer.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NODEBALANCER_S_BACKEND_IPV6_PREFIXGet a NodeBalancer’s backend IPv6 prefix.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NODEBALANCER_S_NODEGet a NodeBalancer’s node.

Input Parameters

string
required
The ID of the Node to access.
integer
required
The ID of the Config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NODE_POOLGet a node pool.

Input Parameters

integer
required
ID of the Pool to look up.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_NOTIFICATION_CHANNELGet a notification channel.

Input Parameters

integer
required
The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_PLACEMENT_GROUPGet a placement group.

Input Parameters

integer
required
ID of the placement group to look up. Run the List placement groups operation and store the id for the applicable placement group.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_POSTGRESQL_CONNECTION_POOLGet a PostgreSQL connection pool.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_POSTGRESQL_MANAGED_DATABASEGet a PostgreSQL Managed Database.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_POSTGRESQL_MANAGED_DATABASE_SSL_CERTIFICATEGet a PostgreSQL Managed Database SSL certificate.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_PREFIX_LISTGet a Prefix List.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique Prefix List ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_PROFILE_S_LOGINGet a profile’s login.

Input Parameters

integer
required
The ID of the login object to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_REGIONGet a region.

Input Parameters

string
required
The abbreviated value (“slug”) for the applicable data center. Run the List regions operation to view the slug for each data center.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_REGION_S_VPC_AVAILABILITYGet a region’s VPC availability.

Input Parameters

string
required
The abbreviated value (“slug”) for the applicable data center. Run the List regions operation to view the slug for each data center.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_RESERVED_IP_ADDRESSGet a reserved IP address.

Input Parameters

string
required
The reserved address to update, view, or delete.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_RESOURCE_LOCKGet a resource lock.

Input Parameters

string
Enum Call the v4beta URL for operations still only in beta.
integer
required
The unique identifier assigned to the resource lock. Run the List resource locks operation and store the id for the applicable resource lock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_RULE_SETGet a Rule Set.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Rule Set to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_SHARE_GROUPGet a share group. This operation is available only through Linode API v4beta.

Input Parameters

string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_STACKSCRIPTGet a StackScript.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The ID of the StackScript to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_STREAMGet a stream.

Input Parameters

integer
required
The unique identifier assigned to the stream. Run the List streams operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_STREAM_S_HISTORYGet a stream’s history.

Input Parameters

integer
required
The unique identifier assigned to the stream. Run the List streams operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_SUPPORT_TICKETGet a support ticket.

Input Parameters

integer
required
The ID of the support ticket.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_TYPEGet a type.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_USER_S_ACCESS_LEVELGet a user’s access level.

Input Parameters

string
required
The username to look up.
string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_AVAILABLE_SERVICES_FOR_A_REGIONGet available services for a region.

Input Parameters

string
required
The abbreviated value (“slug”) for the applicable data center. Run the List regions operation to view the slug for each data center.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VALKEY_MANAGED_DATABASEGet a Valkey Managed Database.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VALKEY_MANAGED_DATABASE_SSL_CERTIFICATEGet a Valkey Managed Database SSL certificate.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VOLUMEGet a volume.

Input Parameters

string
Specifies a JSON object to filter down the results. See Filtering and sorting for details.
integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VOLUME_QUOTAGet a volume quota.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VPCGet a VPC.

Input Parameters

integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VPC_CONFIGURATIONGet a VPC configuration.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.
integer
required
The VPC configuration id for the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_A_VPC_SUBNETGet a VPC subnet.

Input Parameters

integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the VPC Subnet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_CORS_OBJECT_STORAGE_BUCKET_ACCESS_E0_E1Get CORS Object Storage bucket access (E0/E1).

Input Parameters

string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_CURRENT_PROFILEReturn the connected Linode user’s stable identity and security-related profile settings without contact or referral details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_DAILY_LINODE_STATISTICSGet daily Linode statistics.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_DETAILS_FOR_A_SUPPORTED_SERVICE_TYPEGet details for a supported service type.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_MONTHLY_NETWORK_TRANSFER_STATSGet monthly network transfer stats.

Input Parameters

integer
required
Numeric value representing the year to look up.
integer
required
Numeric value representing the month to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_NAT_GATEWAY_ACCOUNT_SETTINGSGet NAT Gateway account settings.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_NETWORKING_INFORMATIONGet networking information.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_NETWORK_USAGEGet network usage.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_NODEBALANCER_STATISTICSGet NodeBalancer statistics.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_OBJECT_STORAGE_GLOBAL_QUOTA_USAGE_DATAGet Object Storage global quota usage data.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
Enum Identifies the Object Storage-related global quota to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_OBJECT_STORAGE_QUOTA_USAGE_DATAGet Object Storage quota usage data.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
Identifies the Object Storage-related global quota to retrieve. This follows the pattern, <quota_type>-<s3_endpoint>, for example, buckets-eu-central-1.linodeobjects.com.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_OBJECT_STORAGE_TRANSFER_DATAGet Object Storage transfer data.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_REGION_PLAN_AVAILABILITYReturn availability for every Linode compute plan in one region, including plans that are currently unavailable.

Input Parameters

string
required
Region ID from LINODE_LIST_REGIONS, for example gb-lon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_RESERVED_IP_PRICINGGet reserved IP pricing.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_THE_ACCOUNT_DELEGATION_FOR_A_CHILD_ACCOUNTGet the account delegation for a child account.

Input Parameters

string
required
A unique identifier for a child account. To get this value, run List child accounts.
string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_THE_CONTROL_PLANE_ACCESS_CONTROL_LISTGet the control plane access control list.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_THE_DEFAULT_ROLE_ASSIGNMENT_FOR_DELEGATE_USERSGet the default role assignment for delegate users.

Input Parameters

string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_THIS_MONTH_S_NETWORK_TRANSFER_STATSGet this month’s network transfer stats.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_USER_S_ACCOUNT_DELEGATIONSGet user’s account delegations.

Input Parameters

string
required
The username to look up.
string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_VOLUME_QUOTA_USAGE_DATAGet volume quota usage data.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_GET_YOUR_ACCOUNT_DELEGATIONSGet your account delegations.

Input Parameters

string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_IMPORT_A_DOMAINImport a domain.

Input Parameters

string
The domain to import.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
The remote nameserver that allows zone transfers (AXFR).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_AGREEMENTSList agreements.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ALERT_DEFINITIONSList alert definitions.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ALERT_DEFINITIONS_FOR_A_SERVICE_TYPEList alert definitions for a service type.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ALERTS_FOR_A_NOTIFICATION_CHANNELList alerts for a notification channel.

Input Parameters

integer
required
The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_LINODE_S_FIREWALLSList a Linode’s firewalls.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The ID of the Linode.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_LINODE_S_NETWORK_INTERFACE_HISTORYList a Linode’s network interface history.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_LINODE_S_VOLUMESList a Linode’s volumes.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
ID of the Linode to look up.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_NAT_GATEWAY_S_IP_ADDRESSESList a NAT Gateway’s IP addresses.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_AVAILABLE_ROLESList available roles.

Input Parameters

string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_AVAILABLE_SERVICESList available services.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_VPC_S_IPV4_ADDRESSESList a VPC’s IPv4 addresses.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The id of the VPC.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_A_VPC_S_IPV6_ADDRESSESList a VPC’s IPv6 addresses.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The id of the VPC.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_BACKUPSList backups.

Input Parameters

integer
required
The ID of the Linode the backups belong to.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_BETA_PROGRAMSList Beta programs.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_CHILD_ACCOUNTSList child accounts.

Input Parameters

boolean
Users added to the account delegation for each child account, false by default.
string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_CONFIGSList configs.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_CONFIGURATION_PROFILE_INTERFACESList configuration profile interfaces.

Input Parameters

integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_CONFIGURATION_PROFILESList configuration profiles.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
ID of the Linode to look up Configuration profiles for.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DASHBOARDSList dashboards.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DASHBOARDS_FOR_A_SERVICE_TYPEList dashboards for a service type.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DEFAULT_FIREWALLSList default firewalls.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DISKSList disks.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
ID of the Linode to look up.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DOMAIN_RECORDSList domain records.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The ID of the Domain we are accessing Records for.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_DOMAINSList domains.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ENROLLED_BETA_PROGRAMSList enrolled Beta programs.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ENTITIESList entities.

Input Parameters

string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_ENTITIES_ASSIGNED_TO_AN_ALERT_DEFINITIONList entities assigned to an alert definition.

Input Parameters

integer
required
The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_EVENTSList events.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
string
Specifies a JSON object to filter down the results. See Filtering and sorting for details.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALL_DEVICESList firewall devices.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALL_RULESList firewall rules.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALL_RULES_WITH_EXPANDED_PREFIX_LISTS_AND_RULE_SETSList firewall rules with expanded Prefix Lists and Rule Sets.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALL_RULE_VERSIONSList firewall rule versions.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALLSList firewalls.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_FIREWALL_TEMPLATESList firewall templates.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_INSTANCESReturn one page of compute instances owned by the connected account, including identifiers and operational metadata needed for inventory workflows.

Input Parameters

string
Continuation cursor from a previous call; omit for the first page.
integer
Maximum records to return in this page (25-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_INSTANCE_TYPESReturn one page of Linode compute plans with hardware specifications, transfer allowances, and base, regional, and backup pricing for cost planning.

Input Parameters

string
Continuation cursor from a previous call; omit for the first page.
integer
Maximum records to return in this page (25-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_INTERFACES_USING_A_NAT_GATEWAY_IPList interfaces using a NAT Gateway IP.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.
string
required
A public IPv4 NAT Gateway address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_INVOICE_ITEMSList invoice items.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
integer
required
The ID of the Invoice.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_INVOICESList invoices.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
string
Specifies a JSON object to filter down the results. See Filtering and sorting for details.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_IP_ADDRESSESList IP addresses.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
When true, the rdns property for any ipv6 type addresses always returns null regardless of whether RDNS data exists for the address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_IPV6_POOLSList IPv6 pools.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_IPV6_RANGESList IPv6 ranges.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_KERNELSReturn one page of Linode kernels with architecture, virtualization compatibility, version, build date, and deprecation status.

Input Parameters

string
Continuation cursor from a previous call; omit for the first page.
integer
Maximum records to return in this page (25-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_KUBERNETES_API_ENDPOINTSList Kubernetes API endpoints.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_KUBERNETES_CLUSTERSList Kubernetes clusters.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_KUBERNETES_TYPESList Kubernetes types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LINODE_INTERFACE_FIREWALLSList Linode interface firewalls.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LINODE_INTERFACESList Linode interfaces.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LINODE_INTERFACE_SETTINGSList Linode interface settings.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LINODE_NODEBALANCERSList Linode NodeBalancers.

Input Parameters

integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LKE_KUBERNETES_VERSIONS_ANY_TIERList LKE Kubernetes versions (any tier).

Input Parameters

string ("standard" | "enterprise")
required
Enum The LKE tier to use.
string
Enum Call the v4beta URL for operations still only in beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LKE_KUBERNETES_VERSIONS_NON_ENTERPRISEList LKE Kubernetes versions (non-enterprise).

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LOGINSList logins.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LONGVIEW_SUBSCRIPTIONSList Longview subscriptions.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_LONGVIEW_TYPESList Longview types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MAINTENANCE_POLICIESList maintenance policies.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MAINTENANCESList maintenances.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_CONTACTSList managed contacts.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_DATABASESList Managed Databases.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_DATABASES_ENGINESList Managed Databases engines.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_DATABASES_TYPESList Managed Databases types.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_ISSUESList managed issues.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_LINODE_SETTINGSList managed Linode settings.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_SERVICESList managed services.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MANAGED_STATSList managed stats.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_METRICS_FOR_A_SERVICE_TYPEList metrics for a service type.

Input Parameters

object
Specifies a JSON object to filter down the results. See Filtering and sorting for details.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MYSQL_MANAGED_DATABASE_ADVANCED_PARAMETERSList MySQL Managed Database advanced parameters.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_MYSQL_MANAGED_DATABASESList MySQL Managed Databases.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NAT_GATEWAY_INTERFACESList NAT Gateway interfaces.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NAT_GATEWAYSList NAT Gateways.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NAT_GATEWAY_TYPESList NAT Gateway types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NETWORK_TRANSFER_PRICESReturn current base and region-specific network transfer prices for estimating Linode data-transfer costs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NODEBALANCER_FIREWALLSList NodeBalancer firewalls.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NODEBALANCERSList NodeBalancers.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NODEBALANCER_TYPESList NodeBalancer types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NODE_POOLSList node pools.

Input Parameters

integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NODESList nodes.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The ID of the NodeBalancer config to access.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NOTIFICATION_CHANNELSList notification channels.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_NOTIFICATIONSList notifications.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_BUCKET_CONTENTSList Object Storage bucket contents.

Input Parameters

string
required
The bucket name.
string
Opaque cursor from the previous page; omit for the first page.
string
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.
string
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.
string
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.
integer
The number of items to return per page.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_BUCKETSList Object Storage buckets.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_BUCKETS_PER_REGIONList Object Storage buckets per region.

Input Parameters

string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_ENDPOINTSList Object Storage endpoints.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_GLOBAL_QUOTASList Object Storage global quotas.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_QUOTASList Object Storage quotas.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_OBJECT_STORAGE_TYPESList Object Storage types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_PLACEMENT_GROUPSList placement groups.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_POSTGRESQL_CONNECTION_POOLSList PostgreSQL connection pools.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_POSTGRESQL_MANAGED_DATABASE_ADVANCED_PARAMETERSList PostgreSQL Managed Database advanced parameters.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_POSTGRESQL_MANAGED_DATABASESList PostgreSQL Managed Databases.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_PREFIX_LISTSList Prefix Lists.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_PUBLIC_IMAGESReturn one page of public Linode operating-system images and lifecycle metadata; private account images are intentionally excluded.

Input Parameters

string
Continuation cursor from a previous call; omit for the first page.
integer
Maximum records to return in this page (25-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_REGIONSReturn one page of Linode regions with status, location, service capabilities, site type, and placement limits for deployment planning.

Input Parameters

string
Continuation cursor from a previous call; omit for the first page.
integer
Maximum records to return in this page (25-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_REGIONS_AVAILABILITYList regions’ availability.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_REGIONS_VPC_AVAILABILITYList regions’ VPC availability.

Input Parameters

string
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_REPLIESList replies.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
integer
required
The ID of the support ticket.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_RESERVED_IP_ADDRESSESList reserved IP addresses.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_RESOURCE_LOCKSList resource locks.

Input Parameters

string
Enum Call the v4beta URL for operations still only in beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_RULE_SETSList Rule Sets.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SHARED_IMAGES_BY_GROUPList shared images by group. This operation is available only through Linode API v4beta.

Input Parameters

string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SHARE_GROUPSList share groups. This operation is available only through Linode API v4beta.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SHARE_GROUPS_BY_IMAGEList share groups by image. This operation is available only through Linode API v4beta.

Input Parameters

string
required
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.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SSO_REQUIRED_USERSList SSO-required users.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The unique identifier of the external identity provider configuration. This is the id value returned by the List IDP configurations operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SSO_USER_EXCEPTIONSList SSO user exceptions.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The unique identifier of the external identity provider configuration. This is the id value returned by the List IDP configurations operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_STACKSCRIPTSList StackScripts.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_STREAMSList streams.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SUPPORTED_SERVICE_TYPESList supported service types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_SUPPORT_TICKETSList support tickets.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_TAGGED_OBJECTSList tagged objects.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string
required
The label of the tag to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_TAGSList tags.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_USER_LOGINSList user logins.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VALKEY_MANAGED_DATABASE_ADVANCED_PARAMETERSList Valkey Managed Database advanced parameters.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VALKEY_MANAGED_DATABASESList Valkey Managed Databases.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VLANSList VLANs.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VOLUME_QUOTASList volume quotas.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VOLUMESList volumes.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
string
Specifies a JSON object to filter down the results. See Filtering and sorting for details.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VOLUME_TYPESList volume types.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPC_CONFIGURATIONSList VPC configurations.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPC_DEFAULT_AND_FORBIDDEN_IPV4_RANGESList VPC default and forbidden IPv4 ranges.

Input Parameters

string
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPC_IPV4_ADDRESSESList VPC IPv4 addresses.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPC_IPV6_ADDRESSESList VPC IPv6 addresses.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPCSList VPCs.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_LIST_VPC_SUBNETSList VPC subnets.

Input Parameters

integer
The page of a collection to return.
string
Opaque cursor from the previous page; omit for the first page.
integer
required
The id of the VPC.
integer
The number of items to return per page.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_MARK_AN_EVENT_AS_SEENMark an event as seen.

Input Parameters

integer
required
The ID of the Event to designate as seen.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_MIGRATE_A_LINODEMigrate a Linode. This operation is destructive and may be irreversible.

Input Parameters

string ("warm" | "cold")
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.
string
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.
boolean
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.
integer
required
ID of the Linode to migrate.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_OPEN_A_SUPPORT_TICKETOpen a support ticket.

Input Parameters

string
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.
string
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.
string
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.
integer
The ID of the VPC entity for the ticket. Run the List VPCs operation and store the id for the target VPC.
string
The summary or title for this support ticket.
integer ("1" | "2" | "3" | "4")
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.
integer
The ID of the domain entity for the ticket. Run the List domains operation and store the id for the target domain.
integer
The ID of the Linode entity for the ticket. Run the List Linodes operation and store the id for the target Linode.
integer
The ID of the volume entity for the ticket. Run the List volumes operation and store the id for the target volume.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
The ID of the Managed Database entity for the ticket. Run the List Managed Databases operation and store the id for the target database.
string
The full details of the issue or question.
integer
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.
string ("service_issue" | "information_request" | "account_request" | "feature_request")
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.
integer
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.
boolean
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.
integer
The ID of the NodeBalancer entity for the ticket. Run the List NodeBalancers operation and store the id for the target NodeBalancer.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_PATCH_A_MYSQL_MANAGED_DATABASEPatch a MySQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_PATCH_A_POSTGRESQL_MANAGED_DATABASEPatch a PostgreSQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_PATCH_A_VALKEY_MANAGED_DATABASEPatch a Valkey Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_PREVIEW_LINODE_INTERFACE_UPGRADEPreview the Linode interface upgrade. This always performs a dry run and makes no changes to the Linode or its interfaces.

Input Parameters

integer
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.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REBOOT_A_LINODEReboot a Linode.

Input Parameters

integer
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.
integer
required
ID of the linode to reboot.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REBUILD_A_LINODERebuild a Linode. This operation is destructive and may be irreversible.

Input Parameters

string
The ID of the Linode type to resize to with this request.
string
required
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.
object
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.
boolean
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.
integer
required
ID of the Linode to rebuild.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string ("enabled" | "disabled")
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.
string ("linode/migrate" | "linode/power_off_on")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REBUILD_A_NODEBALANCER_CONFIGRebuild a non-TLS NodeBalancer config; existing nodes omitted from nodes are deleted.

Input Parameters

integer
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.
string ("none" | "connection" | "http" | "http_body")
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.
array
required
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.
string ("tcp" | "http" | "udp")
required
The non-TLS protocol this configuration serves.
string ("roundrobin" | "leastconn" | "source")
The algorithm this NodeBalancer configuration uses to route traffic to backends.
integer
required
The ID of the Config to access.
string
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.
string
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.
string ("none" | "table" | "http_cookie")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
integer
How long, in seconds, to wait for a check attempt before considering it failed. Must be less than check_interval.
integer
How many times to attempt a check before considering a backend to be down.
integer
How often, in seconds, to check that backends are up and serving requests. Must be greater than check_timeout.
string ("none" | "v1" | "v2")
Proxy protocol mode. v1 and v2 require the tcp protocol.
integer
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.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RECYCLE_A_NODERecycle a node. This operation is destructive and may be irreversible.

Input Parameters

string
required
ID of the Node to be recycled.
integer
required
ID of the Kubernetes cluster containing the Node.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RECYCLE_A_NODE_POOLRecycle a node pool. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Node Pool to be recycled.
integer
required
ID of the Kubernetes cluster this Node Pool is attached to.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RECYCLE_CLUSTER_NODESRecycle cluster nodes. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Kubernetes cluster which contains nodes to be recycled.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REMOVE_A_NAT_GATEWAY_IP_ADDRESSRemove a NAT Gateway IP address. This operation is destructive and may be irreversible.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.
string
required
A public IPv4 NAT Gateway address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REMOVE_AN_OBJECT_STORAGE_BUCKETRemove an Object Storage bucket. This operation is destructive and may be irreversible.

Input Parameters

string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REORDER_CONFIGURATION_PROFILE_INTERFACESReorder configuration profile interfaces.

Input Parameters

array
required
An ordered array of existing configuration profile interface id values. - All current Interface ids 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
integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REPLICATE_AN_IMAGEReplicate an image.

Input Parameters

array
The unique identifier for each compute region. See Regions and images for full details on support for regions.
string
required
The unique identifier assigned to the image after creation.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESERVE_A_PUBLIC_IPV4_ADDRESSReserve a public IPv4 address. This operation is destructive and may be irreversible. This operation may provision billable resources and incur Linode charges.

Input Parameters

array
Tags to apply to this IP that match existing tags.
string
required
Reserve a public IPv4 address from the specified region.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESIZE_A_DISKResize a disk. This operation is destructive and may be irreversible.

Input Parameters

integer
required
The desired size, in MB, of the disk.
integer
required
ID of the Disk to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESIZE_A_LINODEResize a Linode. This operation is destructive and may be irreversible.

Input Parameters

string
required
The ID representing the Linode Type.
integer
required
ID of the Linode to resize.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string ("warm" | "cold")
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.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESIZE_A_VOLUMEResize a volume. This operation is destructive and may be irreversible.

Input Parameters

integer
required
Filterable The volume’s size, in gigabytes.
integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESTORE_A_BACKUPRestore a backup. This operation is destructive and may be irreversible.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The ID of the Backup to restore.
integer
required
The ID of the Linode that the Backup belongs to.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESUME_A_MYSQL_MANAGED_DATABASEResume a MySQL Managed Database.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESUME_A_POSTGRESQL_MANAGED_DATABASEResume a PostgreSQL Managed Database.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_RESUME_A_VALKEY_MANAGED_DATABASEResume a Valkey Managed Database.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_REVOKE_ACCESS_TO_A_SHARED_IMAGERevoke access to a shared image. This operation is available only through Linode API v4beta. This operation is destructive and may be irreversible.

Input Parameters

string
required
Slug identifier assigned to the shared image upon sharing.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_SHARE_IP_ADDRESSESShare IP addresses.

Input Parameters

array
required
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.
integer
required
The ID of the primary Linode that the addresses will be shared with.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_SHUT_DOWN_A_LINODEShut down a Linode. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Linode to shutdown.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_SUSPEND_A_MYSQL_MANAGED_DATABASESuspend a MySQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_SUSPEND_A_POSTGRESQL_MANAGED_DATABASESuspend a PostgreSQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_SUSPEND_A_VALKEY_MANAGED_DATABASESuspend a Valkey Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
Enum Call the v4 URL.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UNASSIGN_A_PLACEMENT_GROUPUnassign a placement group.

Input Parameters

array
The linodeId values for individual Linodes included in the placement group.
integer
required
ID of the placement group to look up. Run the List placement groups operation and store the id for the applicable placement group.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UNRESERVE_AN_IP_ADDRESSUnreserve an IP address. This operation is destructive and may be irreversible.

Input Parameters

string
required
The reserved address to update, view, or delete.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_CONFIGURATION_PROFILEUpdate a configuration profile.

Input Parameters

string
Filterable The name of the configuration for display in Akamai Cloud Manager.
string
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.
object
A dictionary of device disks to use as a device map in a Linode’s configuration profile. - An empty device disk dictionary or a dictionary with empty values for device slots is allowed. - If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.
object
Helpers enabled when booting to this Linode configuration.
string
Optional field for arbitrary user comments on this configuration.
integer
required
The id of the Configuration Profile.
integer
required
The id of the Linode.
string ("default" | "single" | "binbash")
Defines the state of your Linode after booting and can be either default, single, or binbash. Defaults to default.
string ("paravirt" | "fullvirt")
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.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
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.
integer
Defaults to the total RAM of the Linode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_CONFIGURATION_PROFILE_INTERFACEUpdate a configuration profile interface.

Input Parameters

object
IPv4 addresses configured for this interface. This only applies to interfaces with a purpose of vpc.
object
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.
boolean
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.
integer
required
The id of the Configuration Profile.
array
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.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode Configuration Profile Interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_DISKUpdate a disk.

Input Parameters

string
Filterable The name of the disk. This is for display purposes only.
integer
required
ID of the Disk to look up.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_DOMAINUpdate a domain.

Input Parameters

array
Filterable An array of tags applied to this object. Tags are for organizational purposes only.
string ("master" | "slave")
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).
string
Deprecated, Filterable The group this domain belongs to. This is for display purposes only.
string
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.
string ("disabled" | "active")
Indicates whether this domain is currently being rendered, either active or disabled.
integer
“Time to Live” - the amount of time in seconds that this domain’s records may be cached by resolvers or other domain servers. - Valid values are 0, 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.
array
The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
integer
required
The ID of the Domain to access.
integer
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.
string
Start of Authority email address. This is required for type master domains.
integer
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.
array
The IP addresses representing the master DNS for this domain. At least one value is required for type slave domains. The total combined length of all data within this array cannot exceed 1000 characters.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A description for this domain. This is for display purposes only.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_DOMAIN_RECORDUpdate a domain record.

Input Parameters

string ("issue" | "issuewild" | "iodef")
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.
string
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).
integer
The port this Record points to. Only valid and required for SRV record requests.
string
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.
integer
The relative weight of this Record used in the case of identical priority. Higher values are preferred. Only valid and required for SRV record requests.
string
The name of the service. An underscore (_) is prepended and a period (.) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.
integer
“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
integer
The priority of the target host for this Record. Lower values are preferred. Only valid for MX and SRV record requests. Required for SRV record requests. Defaults to 0 for MX record requests. Must be 0 for Null MX records.
string
The protocol this Record’s service communicates with. An underscore (_) is prepended automatically to the submitted value for this property. Only valid for SRV record requests.
integer
required
The ID of the Domain whose Record you are accessing.
integer
required
The ID of the Record you are accessing.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_FIREWALLUpdate a firewall. This operation is destructive and may be irreversible.

Input Parameters

array
Filterable An array of tags applied to this object. Tags are for organizational purposes only.
string
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.
string ("enabled" | "disabled")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_KUBERNETES_CLUSTERUpdate a Kubernetes cluster.

Input Parameters

array
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.
string
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.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
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.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_LINODEUpdate a Linode.

Input Parameters

array
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.
array
Filterable Tags to help you organize your content.
string
Deprecated, Filterable The group label for this Linode.
string
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 (..).
string
Linode request field alerts.
object
Information about this Linode’s backups status. For information about available backups, run List backups.
integer
required
ID of the Linode to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
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.
string ("linode/migrate" | "linode/power_off_on")
The maintenance policy configured by the user for this Linode. Review maintenance policy documentation for more details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_LINODE_INTERFACEUpdate a Linode interface.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the Linode interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_LINODE_S_FIREWALLSUpdate a Linode’s firewalls.

Input Parameters

integer
required
The ID of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_LINODE_S_MANAGED_SETTINGSUpdate a Linode’s managed settings.

Input Parameters

object
The SSH settings for this Linode.
integer
required
The Linode ID whose settings we are accessing.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_LONGVIEW_PLANUpdate a Longview plan.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string ("longview-3" | "longview-10" | "longview-40" | "longview-100")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_MANAGED_CONTACTUpdate a managed contact.

Input Parameters

string
The name of this Contact.
string
The address to email this Contact to alert them of issues.
string
Filterable A grouping for this Contact. This is for display purposes only.
object
Information about how to reach this Contact by phone.
integer
required
The ID of the contact to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_MANAGED_SERVICE_MONITORUpdate a managed service monitor.

Input Parameters

string
What to expect to find in the response body for the Service to be considered up.
string
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
string
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.
integer
How long to wait, in seconds, for a response before considering the Service to be down.
integer
required
The ID of the Managed Service to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
string ("url" | "tcp")
How this Service is monitored, either url or tcp.
string
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_MYSQL_MANAGED_DATABASEUpdate a MySQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
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.
string
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.
object
Configuration settings for automated patch update maintenance for the Managed Database.
string
Filterable The Managed Database engine version.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer ("1" | "2" | "3")
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.
object
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.
object
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.
integer
required
The unique identifier for a MySQL Managed Database. Run the List MySQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_ALERT_DEFINITIONUpdate an alert definition.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
integer
required
The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_EMAIL_ALERT_CHANNELUpdate an alert channel with email-only details; webhook credentials are not accepted.

Input Parameters

string
The name of the notification channel for identification purposes. This value needs to be unique for each notification channel.
object
Configuration settings for an email notification channel.
integer
required
The unique identifier assigned to the monitoring alerts notification channel. Run the List notification channels operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_IMAGEUpdate an image.

Input Parameters

array
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.
string
Filterable A short description of the image.
string
required
The unique identifier assigned to the image after creation.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A detailed description of this image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_IP_ADDRESSUpdate an IP address. This operation is destructive and may be irreversible.

Input Parameters

string
The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. 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.
string
required
The address to operate on.
boolean
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_IP_ADDRESS_S_RDNS_FOR_A_LINODEUpdate an IP address’s RDNS for a Linode.

Input Parameters

string
The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.
string
required
The IP address.
integer
required
The ID of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_AN_OBJECT_S_ACL_CONFIGURATIONUpdate an object’s ACL configuration.

Input Parameters

string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom")
The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.
string
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.
string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_NODEUpdate a node.

Input Parameters

object
required
JSON request body matching the cited Linode operation schema.
string
required
The ID of the Node to access.
integer
required
The ID of the Config to access.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_NODEBALANCERUpdate a NodeBalancer.

Input Parameters

array
Filterable An array of Tags applied to this object. Tags are for organizational purposes only.
string
Filterable This NodeBalancer’s label. These must be unique on your Account.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The ID of the NodeBalancer.
integer
Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_NODEBALANCER_CONFIGUpdate at least one field on a non-TLS TCP, HTTP, or UDP NodeBalancer config.

Input Parameters

integer
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.
string ("none" | "connection" | "http" | "http_body")
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.
string ("tcp" | "http" | "udp")
The non-TLS protocol this configuration serves.
string ("roundrobin" | "leastconn" | "source")
The algorithm this NodeBalancer configuration uses to route traffic to backends.
integer
required
The ID of the Config to access.
string
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.
string
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.
string ("none" | "table" | "http_cookie")
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
integer
Number of seconds to wait for a check attempt before considering it failed. Must be less than check_interval.
integer
How many times to attempt a check before considering a backend to be down.
integer
Number of seconds between checks to verify that backends are up and serving requests. Must be greater than check_timeout.
string ("none" | "v1" | "v2")
Proxy protocol mode. v1 and v2 require the tcp protocol.
integer
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.
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_NODEBALANCER_S_FIREWALLSUpdate a NodeBalancer’s firewalls.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
required
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, [].
integer
required
The ID of the NodeBalancer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_NODE_POOLUpdate a node pool. This operation is destructive and may be irreversible.

Input Parameters

array
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.
integer
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.
object
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 "".
array
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.
integer
required
ID of the Pool to look up.
object
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.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_PLACEMENT_GROUPUpdate a placement group.

Input Parameters

string
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 (.).
integer
required
ID of the placement group to look up. Run the List placement groups operation and store the id for the applicable placement group.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_POSTGRESQL_CONNECTION_POOLUpdate a PostgreSQL connection pool.

Input Parameters

string ("session" | "statement" | "transaction")
Set the connection pooling mode based on the specification set by our partner, Aiven. Select from transaction, session, or statement.
integer
The number of connections in the pool. This can’t exceed the number of available connections for your service plan.
string
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.
string
The username of the client making the connection. The default of null reuses the inbound user.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_POSTGRESQL_MANAGED_DATABASEUpdate a PostgreSQL Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
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.
string
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.
object
Configuration settings for automated patch update maintenance for the Managed Database.
string
Filterable The Managed Database engine version.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer ("1" | "2" | "3")
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.
object
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.
object
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.
integer
required
The unique identifier for a PostgreSQL Managed Database. Run the List PostgreSQL Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_RULE_SETUpdate a Rule Set.

Input Parameters

string
Filterable Unique, user-defined label for this Rule Set. This label helps you identify and describe your Rule Set.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
Describes this Rule Set. For display purposes only.
integer
required
ID of the Rule Set to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_SHARED_IMAGEUpdate a shared image. This operation is available only through Linode API v4beta.

Input Parameters

string
The shared image’s descriptive name.
string
required
Slug identifier assigned to the shared image upon sharing.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A detailed description of this image share.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_SHARE_GROUPUpdate a share group. This operation is available only through Linode API v4beta.

Input Parameters

string
The share group’s descriptive name.
string
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A detailed description of this share group.
integer
required
The share group’s unique identifier assigned after creating it. Not to be confused with the group’s uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_STACKSCRIPTUpdate a StackScript.

Input Parameters

string
Filterable The StackScript’s label is for display purposes only.
array
An array of Image IDs. These are the Images that can be deployed with this StackScript. any/all indicates that all available Images, including private Images, are accepted.
string
The script to execute when provisioning a new Linode with this StackScript.
string
Filterable This field allows you to add notes for the set of revisions made to this StackScript.
boolean
Filterable This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
Filterable A description for the StackScript.
string
required
The ID of the StackScript to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_STREAMUpdate a stream.

Input Parameters

string
The name of the stream. This is used for display purposes in Akamai Cloud Manager.
string ("active" | "inactive")
The availability status of the stream. This can be active or inactive.
object
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.
integer
required
The unique identifier assigned to the stream. Run the List streams operation and store the id for the applicable one.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_USER_S_ACCESS_LEVELUpdate a user’s access level.

Input Parameters

string
required
The username to look up.
string
Enum Call the v4 URL.
array
required
Encapsulates assigned entity access roles and entities they apply to.
array
required
Assigned account access roles. For a list of available account access roles and their included permissions, see Available roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_VALKEY_MANAGED_DATABASEUpdate a Valkey Managed Database. This operation is destructive and may be irreversible.

Input Parameters

string
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.
string
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.
string
Filterable The unique identifier for the region where the Managed Database lives.
object
Configuration settings for automated patch update maintenance for the Managed Database.
string
Filterable The Managed Database engine version.
array
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer ("1" | "2" | "3")
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.
object
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.
object
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.
integer
required
The unique identifier for a Valkey Managed Database. Run the List Valkey Managed Databases operation and store the id for the desired one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_VOLUMEUpdate a volume.

Input Parameters

array
Any tags applied to this object. Use tags to label and organize your cloud computing resources.
string
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.
integer
required
The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_VPCUpdate a VPC.

Input Parameters

array
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.
string
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 (--).
integer
required
The id of the VPC.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
A written description to help distinguish the VPC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_A_VPC_SUBNETUpdate a VPC subnet. This operation is destructive and may be irreversible.

Input Parameters

string
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 (-).
integer
required
The id of the VPC.
integer
The unique identifier of the attached NAT Gateway instance.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
The id of the VPC Subnet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_CORS_ACCESS_TO_AN_OBJECT_STORAGE_BUCKET_E0_E1Update CORS access to an Object Storage bucket (E0/E1).

Input Parameters

string ("private" | "public-read" | "authenticated-read" | "public-read-write" | "custom")
The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.
string
required
The bucket name.
string
required
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.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
Whether cross-origin resource sharing (CORS) is enabled for all origins on the bucket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_DEFAULT_FIREWALLSUpdate default firewalls.

Input Parameters

string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
object
The default firewall ID for a linode, nodebalancer, public_interface, or vpc_interface. Default firewalls can’t be deleted or disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_FIREWALL_RULESUpdate firewall rules.

Input Parameters

object
JSON request body matching the cited Linode operation schema.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the Firewall to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_LINODE_INTERFACE_SETTINGSUpdate Linode interface settings.

Input Parameters

integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
object
Interfaces used for the IPv4 default_route and IPv6 default_route when multiple interfaces are eligible for the role.
boolean
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.
string ("default" | "true")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_NAT_GATEWAY_LABELUpdate NAT Gateway label.

Input Parameters

string
required
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 (--).
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
integer
required
ID of the NAT Gateway to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_RESERVED_IP_ADDRESS_TAGSUpdate reserved IP address tags.

Input Parameters

array
required
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.
string
required
The reserved address to update, view, or delete.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_SSO_REQUIRED_USERSUpdate SSO-required users.

Input Parameters

array
required
The usernames to set for the SSO user exceptions or SSO-required lists. Pass an empty array to clear the list.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The unique identifier of the external identity provider configuration. This is the id value returned by the List IDP configurations operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_SSO_USER_EXCEPTIONSUpdate SSO user exceptions.

Input Parameters

array
required
The usernames to set for the SSO user exceptions or SSO-required lists. Pass an empty array to clear the list.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
string
required
The unique identifier of the external identity provider configuration. This is the id value returned by the List IDP configurations operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_THE_ACCOUNT_DELEGATION_FOR_A_CHILD_ACCOUNTUpdate the account delegation for a child account.

Input Parameters

string
required
A unique identifier for a child account. To get this value, run List child accounts.
array
Usernames to add to the account delegation for the child account.
string
Enum Call the v4 URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_THE_CONTROL_PLANE_ACCESS_CONTROL_LISTUpdate the control plane access control list.

Input Parameters

object
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.
integer
required
ID of the Kubernetes cluster to look up.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_THE_DEFAULT_ROLE_ASSIGNMENT_FOR_DELEGATE_USERSUpdate the default role assignment for delegate users.

Input Parameters

string
Enum Call the v4 URL.
array
required
Encapsulates assigned entity access roles and entities they apply to.
array
required
Assigned account access roles. For a list of available account access roles and their included permissions, see Available roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPDATE_YOUR_ACCOUNTUpdate your account.

Input Parameters

string
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.
string
The city for this account’s address.
string
The email address of the person assigned to this account.
string
The phone number assigned to this account.
string
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.
string
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.
string
The company name assigned to this account. This value can’t include the characters, < > ( ) " =.
string
The two-letter ISO 3166 country code for this account’s address.
string
The first line of this account’s billing address.
string
The second line of this account’s billing address.
string
The last name of the person assigned to this account. This value can’t include the characters, < > ( ) " =.
string
The first name of the person assigned to this account. This value can’t include the characters, < > ( ) " =.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPGRADE_A_LINODEUpgrade a Linode. This operation is destructive and may be irreversible.

Input Parameters

integer
required
ID of the Linode to mutate.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINODE_UPGRADE_TO_LINODE_INTERFACESIrreversibly upgrade legacy configuration interfaces to Linode interfaces. This changes the Linode’s interfaces and removes all legacy config interfaces.

Input Parameters

integer
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.
integer
required
The id of the Linode.
string ("v4" | "v4beta")
Enum Call either the v4 URL, or v4beta for operations still in Beta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not