Account ======= This section details Account-related Linode CLI commands. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_view: `view `_ ---------------------------------------------------------------------- Returns the contact and billing information related to your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account view [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account view .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_since` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date and time the account was activated. * - :action-table-field-name:`address_1` - :action-table-field-type:`str` - :action-table-field-example:`123 Main Street` - First line of this Account's billing address. * - :action-table-field-name:`address_2` - :action-table-field-type:`str` - :action-table-field-example:`Suite A` - Second line of this Account's billing address. * - :action-table-field-name:`balance` - :action-table-field-type:`float` - :action-table-field-example:`200` - This Account's balance, in US dollars. * - :action-table-field-name:`balance_uninvoiced` - :action-table-field-type:`float` - :action-table-field-example:`145` - This Account's current estimated invoice in US dollars. * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`akamai` - The source of service charges for this Account, as determined by its relationship with Akamai. * - :action-table-field-name:`capabilities` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", "...ent Groups"]` - A list of capabilities your account supports. * - :action-table-field-name:`city` - :action-table-field-type:`str` - :action-table-field-example:`Philadelphia` - The city for this Account's billing address. * - :action-table-field-name:`company` - :action-table-field-type:`str` - :action-table-field-example:`Linode LLC` - The company name associated with this Account. * - :action-table-field-name:`country` - :action-table-field-type:`str` - :action-table-field-example:`US` - The two-letter ISO 3166 country code of this Account's billing address. * - :action-table-field-name:`email` - :action-table-field-type:`str` - :action-table-field-example:`john.smith@linode.com` - The email address of the person associated with this Account. * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - :action-table-field-example:`E1AF5EEC-526F...EBEB34C87D71` - An external unique identifier for this account. * - :action-table-field-name:`first_name` - :action-table-field-type:`str` - :action-table-field-example:`John` - The first name of the person associated with this Account. * - :action-table-field-name:`last_name` - :action-table-field-type:`str` - :action-table-field-example:`Smith` - The last name of the person associated with this Account. * - :action-table-field-name:`phone` - :action-table-field-type:`str` - :action-table-field-example:`215-555-1212` - The phone number associated with this Account. * - :action-table-field-name:`state` - :action-table-field-type:`str` - :action-table-field-example:`PA` - If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. * - :action-table-field-name:`tax_id` - :action-table-field-type:`str` - :action-table-field-example:`ATU99999999` - The tax identification number associated with this Account, for tax calculations in some countries. * - :action-table-field-name:`zip` - :action-table-field-type:`str` - :action-table-field-example:`19102-1234` - The zip code of this Account's billing address. .. _commands_account_view_attribute_sections_active_promotions: .. rst-class:: action-section-header active_promotions .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_promotions.credit_monthly_cap` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount available to spend per month. * - :action-table-field-name:`active_promotions.credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`50.00` - The total amount of credit left for this promotion. * - :action-table-field-name:`active_promotions.description` - :action-table-field-type:`str` - :action-table-field-example:`Receive up to...period ends.` - A detailed description of this promotion. * - :action-table-field-name:`active_promotions.expire_dt` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-31T23:59:59` - When this promotion's credits expire. * - :action-table-field-name:`active_promotions.image_url` - :action-table-field-type:`str` - :action-table-field-example:`https://linod...romotion.svg` - The location of an image for this promotion. * - :action-table-field-name:`active_promotions.service_type` - :action-table-field-type:`str` - :action-table-field-example:`all` - The service to which this promotion applies. * - :action-table-field-name:`active_promotions.summary` - :action-table-field-type:`str` - :action-table-field-example:`$10 off your...ode a month!` - Short details of this promotion. * - :action-table-field-name:`active_promotions.this_month_credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount of credit left for this month for this promotion. .. _commands_account_view_attribute_sections_credit_card: .. rst-class:: action-section-header credit_card .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`credit_card.expiry` - :action-table-field-type:`str` - :action-table-field-example:`11/2022` - The expiration month and year of the credit card. * - :action-table-field-name:`credit_card.last_four` - :action-table-field-type:`str` - :action-table-field-example:`1111` - The last four digits of the credit card associated with this Account. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_update: `update `_ ------------------------------------------------------------------------ Updates contact and billing information related to your account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account update [-h] [--city city] [--state state] [--first_name first_name] [--zip zip] [--address_2 address_2] [--company company] [--active_promotions.service_type service_type] [--active_promotions.this_month_credit_remaining this_month_credit_remaining] [--active_promotions.expire_dt expire_dt] [--active_promotions.summary summary] [--active_promotions.credit_monthly_cap credit_monthly_cap] [--active_promotions.credit_remaining credit_remaining] [--active_promotions.image_url image_url] [--active_promotions.description description] [--phone phone] [--tax_id tax_id] [--email email] [--country country] [--last_name last_name] [--address_1 address_1] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account update \ --address_1 "123 Main St." \ --address_2 "Suite 101" \ --city Philadelphia \ --company My Company \ LLC \ --country US \ --email jsmith@mycompany.com \ --first_name John \ --last_name Smith \ --phone 555-555-1212 \ --state PA \ --tax_id ATU99999999 \ --zip 19102 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-address_1` - :action-table-field-type:`str` - :action-table-field-example:`123 Main Street` - First line of this Account's billing address. * - :action-table-field-name:`\-\-address_2` - :action-table-field-type:`str` - :action-table-field-example:`Suite A` - Second line of this Account's billing address. * - :action-table-field-name:`\-\-city` - :action-table-field-type:`str` - :action-table-field-example:`Philadelphia` - The city for this Account's billing address. * - :action-table-field-name:`\-\-company` - :action-table-field-type:`str` - :action-table-field-example:`Linode LLC` - The company name associated with this Account. * - :action-table-field-name:`\-\-country` - :action-table-field-type:`str` - :action-table-field-example:`US` - The two-letter ISO 3166 country code of this Account's billing address. * - :action-table-field-name:`\-\-email` - :action-table-field-type:`str` - :action-table-field-example:`john.smith@linode.com` - The email address of the person associated with this Account. * - :action-table-field-name:`\-\-first_name` - :action-table-field-type:`str` - :action-table-field-example:`John` - The first name of the person associated with this Account. * - :action-table-field-name:`\-\-last_name` - :action-table-field-type:`str` - :action-table-field-example:`Smith` - The last name of the person associated with this Account. * - :action-table-field-name:`\-\-phone` - :action-table-field-type:`str` - :action-table-field-example:`215-555-1212` - The phone number associated with this Account. * - :action-table-field-name:`\-\-state` - :action-table-field-type:`str` - :action-table-field-example:`PA` - If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. * - :action-table-field-name:`\-\-tax_id` - :action-table-field-type:`str` - :action-table-field-example:`ATU99999999` - The tax identification number associated with this Account, for tax calculations in some countries. * - :action-table-field-name:`\-\-zip` - :action-table-field-type:`str` - :action-table-field-example:`19102-1234` - The zip code of this Account's billing address. .. _commands_account_update_argument_sections_active_promotions: .. rst-class:: action-section-header active_promotions .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-active_promotions.credit_monthly_cap` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount available to spend per month. * - :action-table-field-name:`\-\-active_promotions.credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`50.00` - The total amount of credit left for this promotion. * - :action-table-field-name:`\-\-active_promotions.description` - :action-table-field-type:`str` - :action-table-field-example:`Receive up to...period ends.` - A detailed description of this promotion. * - :action-table-field-name:`\-\-active_promotions.expire_dt` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-31T23:59:59` - When this promotion's credits expire. * - :action-table-field-name:`\-\-active_promotions.image_url` - :action-table-field-type:`str` - :action-table-field-example:`https://linod...romotion.svg` - The location of an image for this promotion. * - :action-table-field-name:`\-\-active_promotions.service_type` - :action-table-field-type:`str` - :action-table-field-example:`all` - The service to which this promotion applies. * - :action-table-field-name:`\-\-active_promotions.summary` - :action-table-field-type:`str` - :action-table-field-example:`$10 off your...ode a month!` - Short details of this promotion. * - :action-table-field-name:`\-\-active_promotions.this_month_credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount of credit left for this month for this promotion. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_since` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date and time the account was activated. * - :action-table-field-name:`address_1` - :action-table-field-type:`str` - :action-table-field-example:`123 Main Street` - First line of this Account's billing address. * - :action-table-field-name:`address_2` - :action-table-field-type:`str` - :action-table-field-example:`Suite A` - Second line of this Account's billing address. * - :action-table-field-name:`balance` - :action-table-field-type:`float` - :action-table-field-example:`200` - This Account's balance, in US dollars. * - :action-table-field-name:`balance_uninvoiced` - :action-table-field-type:`float` - :action-table-field-example:`145` - This Account's current estimated invoice in US dollars. * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`akamai` - The source of service charges for this Account, as determined by its relationship with Akamai. * - :action-table-field-name:`capabilities` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", "...ent Groups"]` - A list of capabilities your account supports. * - :action-table-field-name:`city` - :action-table-field-type:`str` - :action-table-field-example:`Philadelphia` - The city for this Account's billing address. * - :action-table-field-name:`company` - :action-table-field-type:`str` - :action-table-field-example:`Linode LLC` - The company name associated with this Account. * - :action-table-field-name:`country` - :action-table-field-type:`str` - :action-table-field-example:`US` - The two-letter ISO 3166 country code of this Account's billing address. * - :action-table-field-name:`email` - :action-table-field-type:`str` - :action-table-field-example:`john.smith@linode.com` - The email address of the person associated with this Account. * - :action-table-field-name:`euuid` - :action-table-field-type:`str` - :action-table-field-example:`E1AF5EEC-526F...EBEB34C87D71` - An external unique identifier for this account. * - :action-table-field-name:`first_name` - :action-table-field-type:`str` - :action-table-field-example:`John` - The first name of the person associated with this Account. * - :action-table-field-name:`last_name` - :action-table-field-type:`str` - :action-table-field-example:`Smith` - The last name of the person associated with this Account. * - :action-table-field-name:`phone` - :action-table-field-type:`str` - :action-table-field-example:`215-555-1212` - The phone number associated with this Account. * - :action-table-field-name:`state` - :action-table-field-type:`str` - :action-table-field-example:`PA` - If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. * - :action-table-field-name:`tax_id` - :action-table-field-type:`str` - :action-table-field-example:`ATU99999999` - The tax identification number associated with this Account, for tax calculations in some countries. * - :action-table-field-name:`zip` - :action-table-field-type:`str` - :action-table-field-example:`19102-1234` - The zip code of this Account's billing address. .. _commands_account_update_attribute_sections_active_promotions: .. rst-class:: action-section-header active_promotions .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`active_promotions.credit_monthly_cap` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount available to spend per month. * - :action-table-field-name:`active_promotions.credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`50.00` - The total amount of credit left for this promotion. * - :action-table-field-name:`active_promotions.description` - :action-table-field-type:`str` - :action-table-field-example:`Receive up to...period ends.` - A detailed description of this promotion. * - :action-table-field-name:`active_promotions.expire_dt` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-31T23:59:59` - When this promotion's credits expire. * - :action-table-field-name:`active_promotions.image_url` - :action-table-field-type:`str` - :action-table-field-example:`https://linod...romotion.svg` - The location of an image for this promotion. * - :action-table-field-name:`active_promotions.service_type` - :action-table-field-type:`str` - :action-table-field-example:`all` - The service to which this promotion applies. * - :action-table-field-name:`active_promotions.summary` - :action-table-field-type:`str` - :action-table-field-example:`$10 off your...ode a month!` - Short details of this promotion. * - :action-table-field-name:`active_promotions.this_month_credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount of credit left for this month for this promotion. .. _commands_account_update_attribute_sections_credit_card: .. rst-class:: action-section-header credit_card .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`credit_card.expiry` - :action-table-field-type:`str` - :action-table-field-example:`11/2022` - The expiration month and year of the credit card. * - :action-table-field-name:`credit_card.last_four` - :action-table-field-type:`str` - :action-table-field-example:`1111` - The last four digits of the credit card associated with this Account. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_cancel: `cancel `_ -------------------------------------------------------------------------------- Cancels an active Linode account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account cancel [-h] [--comments comments] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account cancel \ --comments "I'm consolidating my accounts" .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-comments` - :action-table-field-type:`str` - :action-table-field-example:`I'm consolida...ts into one.` - Any reason for cancelling the account, and any other comments you might have about your Linode service. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`survey_link` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A link to Linode's exit survey. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_settings: `settings `_ ----------------------------------------------------------------------------------- Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account settings [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account settings .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`backups_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Account-wide backups default. * - :action-table-field-name:`longview_subscription` - :action-table-field-type:`str` - :action-table-field-example:`longview-3` - The Longview Pro tier you are currently subscribed to. * - :action-table-field-name:`managed` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Our 24/7 incident response service. * - :action-table-field-name:`network_helper` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Enables network helper across all users by default for new Linodes and Linode Configs. * - :action-table-field-name:`object_storage` - :action-table-field-type:`str` - :action-table-field-example:`active` - A string describing the status of this account's Object Storage service enrollment. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_transfer: `transfer `_ --------------------------------------------------------------------------- Returns a Transfer object showing your network utilization, in GB, for the current month. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account transfer [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account transfer .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`billable` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The amount of your transfer pool that is billable this billing cycle. * - :action-table-field-name:`quota` - :action-table-field-type:`int` - :action-table-field-example:`9141` - The amount of network usage allowed this billing cycle. * - :action-table-field-name:`used` - :action-table-field-type:`int` - :action-table-field-example:`2` - The amount of network usage you have used this billing cycle. .. _commands_account_transfer_attribute_sections_region_transfers: .. rst-class:: action-section-header region_transfers .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`region_transfers.billable` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The amount of your transfer pool that is billable this billing cycle for this Region. * - :action-table-field-name:`region_transfers.id` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region ID for this network utilization data. * - :action-table-field-name:`region_transfers.quota` - :action-table-field-type:`int` - :action-table-field-example:`5010` - The amount of network usage allowed this billing cycle for this Region. * - :action-table-field-name:`region_transfers.used` - :action-table-field-type:`int` - :action-table-field-example:`1` - The amount of network usage you have used this billing cycle for this Region. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_client-view: `client-view `_ ---------------------------------------------------------------------------- Returns information about a single OAuth client. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account client-view [-h] [--label label] [--public public] [--order-by {label,public}] [--order {asc,desc}] clientId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account client-view \ edc6790ea9db4d224c5c .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`clientId` - :action-table-field-type:`str` - The OAuth Client ID to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`2737bf16b39ab5d7b4a1` - The OAuth Client ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`secret` - :action-table-field-type:`str` - :action-table-field-example:`` - The OAuth Client secret, used in the OAuth exchange. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The status of this application. * - :action-table-field-name:`thumbnail_url` - :action-table-field-type:`str` - :action-table-field-example:`https://api....a1/thumbnail` - The URL where this client's thumbnail may be viewed, or ``null`` if this client does not have a thumbnail set. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_client-create: `client-create `_ ------------------------------------------------------------------------------- Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account client-create [-h] [--redirect_uri redirect_uri] [--public public] [--label label] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account client-create \ --label Test_Client_1 \ --redirect_uri https://example.org/callback .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-label` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`\-\-redirect_uri` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`\-\-public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`2737bf16b39ab5d7b4a1` - The OAuth Client ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`secret` - :action-table-field-type:`str` - :action-table-field-example:`` - The OAuth Client secret, used in the OAuth exchange. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The status of this application. * - :action-table-field-name:`thumbnail_url` - :action-table-field-type:`str` - :action-table-field-example:`https://api....a1/thumbnail` - The URL where this client's thumbnail may be viewed, or ``null`` if this client does not have a thumbnail set. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_client-update: `client-update `_ ------------------------------------------------------------------------------ Update information about an OAuth Client on your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account client-update [-h] [--label label] [--public public] [--redirect_uri redirect_uri] clientId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account client-update \ edc6790ea9db4d224c5c \ --label Test_Client_1 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`clientId` - :action-table-field-type:`str` - The OAuth Client ID to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`\-\-public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`\-\-redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`2737bf16b39ab5d7b4a1` - The OAuth Client ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`secret` - :action-table-field-type:`str` - :action-table-field-example:`` - The OAuth Client secret, used in the OAuth exchange. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The status of this application. * - :action-table-field-name:`thumbnail_url` - :action-table-field-type:`str` - :action-table-field-example:`https://api....a1/thumbnail` - The URL where this client's thumbnail may be viewed, or ``null`` if this client does not have a thumbnail set. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_client-delete: `client-delete `_ --------------------------------------------------------------------------------- Deletes an OAuth Client registered with Linode. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account client-delete [-h] clientId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account client-delete \ edc6790ea9db4d224c5c .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`clientId` - :action-table-field-type:`str` - The OAuth Client ID to look up. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_client-reset-secret: `client-reset-secret `_ -------------------------------------------------------------------------------------------------- Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account client-reset-secret [-h] clientId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account client-reset-secret \ edc6790ea9db4d224c5c .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`clientId` - :action-table-field-type:`str` - The OAuth Client ID to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`2737bf16b39ab5d7b4a1` - The OAuth Client ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`secret` - :action-table-field-type:`str` - :action-table-field-example:`` - The OAuth Client secret, used in the OAuth exchange. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The status of this application. * - :action-table-field-name:`thumbnail_url` - :action-table-field-type:`str` - :action-table-field-example:`https://api....a1/thumbnail` - The URL where this client's thumbnail may be viewed, or ``null`` if this client does not have a thumbnail set. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_clients-list: `clients-list `_ ------------------------------------------------------------------------------ Returns a paginated list of OAuth Clients registered to your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account clients-list [-h] [--label label] [--public public] [--order-by {label,public}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account clients-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The name of this application. * - :action-table-field-name:`\-\-public` - :action-table-field-type:`bool` - If this is a public or private OAuth Client. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`2737bf16b39ab5d7b4a1` - The OAuth Client ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Test_Client_1` - The name of this application. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this is a public or private OAuth Client. * - :action-table-field-name:`redirect_uri` - :action-table-field-type:`str` - :action-table-field-example:`https://exam...uth/callback` - The location a successful log in from `login.linode.com `_ should be redirected to for this client. * - :action-table-field-name:`secret` - :action-table-field-type:`str` - :action-table-field-example:`` - The OAuth Client secret, used in the OAuth exchange. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The status of this application. * - :action-table-field-name:`thumbnail_url` - :action-table-field-type:`str` - :action-table-field-example:`https://api....a1/thumbnail` - The URL where this client's thumbnail may be viewed, or ``null`` if this client does not have a thumbnail set. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_enable-managed: `enable-managed `_ ------------------------------------------------------------------------------------------------ Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account enable-managed [-h] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account enable-managed ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_get-account-availability: `get-account-availability `_ ------------------------------------------------------------------------------------------------------- View the available services for your account in a specific region. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account get-account-availability [-h] [--order-by {}] [--order {asc,desc}] id .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account get-account-availability us-east .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`id` - :action-table-field-type:`str` - The slug for the applicable data center. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`available` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", ...eBalancers"]` - A list of services _available_ to your account in the ``region``. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Akamai cloud computing data center (region), represented by a slug value. * - :action-table-field-name:`unavailable` - :action-table-field-type:`[]str` - :action-table-field-example:`["Kubernetes"...ck Storage"]` - A list of services _unavailable_ to your account in the ``region``. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_get-availability: `get-availability `_ --------------------------------------------------------------------------------------- Returns a paginated list of the services available to you, for all Linode regions. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account get-availability [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account get-availability .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`available` - :action-table-field-type:`[]str` - :action-table-field-example:`["Linodes", ...eBalancers"]` - A list of services _available_ to your account in the ``region``. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Akamai cloud computing data center (region), represented by a slug value. * - :action-table-field-name:`unavailable` - :action-table-field-type:`[]str` - :action-table-field-example:`["Kubernetes"...ck Storage"]` - A list of services _unavailable_ to your account in the ``region``. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_invoice-view: `invoice-view `_ ------------------------------------------------------------------------------ Returns a single Invoice object. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account invoice-view [-h] [--label label] [--total total] [--date date] [--billing_source billing_source] [--order-by {label,total,date,billing_source}] [--order {asc,desc}] invoiceId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account invoice-view 123 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`invoiceId` - :action-table-field-type:`int` - The ID of the Invoice. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`linode` - ``akamai``: This Invoice was generated according to the terms of an agreement between the customer and Akamai. * - :action-table-field-name:`date` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Invoice was generated. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The Invoice's unique ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Invoice` - The Invoice's display label. * - :action-table-field-name:`subtotal` - :action-table-field-type:`float` - :action-table-field-example:`120.25` - The amount of the Invoice before taxes in US Dollars. * - :action-table-field-name:`tax` - :action-table-field-type:`float` - :action-table-field-example:`12.25` - The amount of tax levied on the Invoice in US Dollars. * - :action-table-field-name:`total` - :action-table-field-type:`float` - :action-table-field-example:`132.5` - The amount of the Invoice after taxes in US Dollars. .. _commands_account_invoice-view_attribute_sections_tax_summary: .. rst-class:: action-section-header tax_summary .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`tax_summary.name` - :action-table-field-type:`str` - :action-table-field-example:`PA STATE TAX` - The source of this tax subtotal. * - :action-table-field-name:`tax_summary.tax` - :action-table-field-type:`float` - :action-table-field-example:`12.25` - The amount of tax subtotal attributable to this source. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_invoice-items: `invoice-items `_ ------------------------------------------------------------------------------------- Returns a paginated list of Invoice items. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account invoice-items [-h] [--order-by {}] [--order {asc,desc}] invoiceId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account invoice-items 123 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`invoiceId` - :action-table-field-type:`int` - The ID of the Invoice. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`amount` - :action-table-field-type:`float` - :action-table-field-example:`20.2` - The price, in US dollars, of the Invoice Item. * - :action-table-field-name:`from` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date the Invoice Item started, based on month. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Linode 123` - The Invoice Item's display label. * - :action-table-field-name:`quantity` - :action-table-field-type:`int` - :action-table-field-example:`4` - The quantity of this Item for the specified Invoice. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-west` - The ID of the applicable Region associated with this Invoice Item. * - :action-table-field-name:`tax` - :action-table-field-type:`float` - :action-table-field-example:`1.25` - The amount of tax levied on this Item in US Dollars. * - :action-table-field-name:`to` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-31T11:59:59` - The date the Invoice Item ended, based on month. * - :action-table-field-name:`total` - :action-table-field-type:`float` - :action-table-field-example:`21.45` - The price of this Item after taxes in US Dollars. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`hourly` - The type of service, ether ``hourly`` or ``misc``. * - :action-table-field-name:`unit_price` - :action-table-field-type:`str` - :action-table-field-example:`5.05` - The monthly service fee in US Dollars for this Item. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_invoices-list: `invoices-list `_ -------------------------------------------------------------------------------- Returns a paginated list of Invoices against your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account invoices-list [-h] [--total total] [--date date] [--billing_source billing_source] [--label label] [--order-by {total,date,billing_source,label}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account invoices-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-billing_source` - :action-table-field-type:`str` - ``akamai``: This Invoice was generated according to the terms of an agreement between the customer and Akamai. * - :action-table-field-name:`\-\-date` - :action-table-field-type:`str` - When this Invoice was generated. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The Invoice's display label. * - :action-table-field-name:`\-\-total` - :action-table-field-type:`float` - The amount of the Invoice after taxes in US Dollars. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`billing_source` - :action-table-field-type:`str` - :action-table-field-example:`linode` - ``akamai``: This Invoice was generated according to the terms of an agreement between the customer and Akamai. * - :action-table-field-name:`date` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Invoice was generated. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The Invoice's unique ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Invoice` - The Invoice's display label. * - :action-table-field-name:`subtotal` - :action-table-field-type:`float` - :action-table-field-example:`120.25` - The amount of the Invoice before taxes in US Dollars. * - :action-table-field-name:`tax` - :action-table-field-type:`float` - :action-table-field-example:`12.25` - The amount of tax levied on the Invoice in US Dollars. * - :action-table-field-name:`total` - :action-table-field-type:`float` - :action-table-field-example:`132.5` - The amount of the Invoice after taxes in US Dollars. .. _commands_account_invoices-list_attribute_sections_tax_summary: .. rst-class:: action-section-header tax_summary .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`tax_summary.name` - :action-table-field-type:`str` - :action-table-field-example:`PA STATE TAX` - The source of this tax subtotal. * - :action-table-field-name:`tax_summary.tax` - :action-table-field-type:`float` - :action-table-field-example:`12.25` - The amount of tax subtotal attributable to this source. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_login-view: `login-view `_ ---------------------------------------------------------------------------------- Returns a Login object that displays information about a successful login. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account login-view [-h] [--order-by {}] [--order {asc,desc}] loginId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account login-view 1234 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`loginId` - :action-table-field-type:`int` - The ID of the login object to access. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`datetime` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When the login was initiated. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - The unique ID of this login object. * - :action-table-field-name:`ip` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The remote IP address that requested the login. * - :action-table-field-name:`restricted` - :action-table-field-type:`bool` - :action-table-field-example:`true` - True if the User that attempted the login was a restricted User, false otherwise. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`successful` - Whether the login attempt succeeded or failed. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`example_user` - The username of the User that attempted the login. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_logins-list: `logins-list `_ ------------------------------------------------------------------------------------ Returns a collection of successful logins for all users on the account during the last 90 days. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account logins-list [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account logins-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`datetime` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When the login was initiated. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - The unique ID of this login object. * - :action-table-field-name:`ip` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The remote IP address that requested the login. * - :action-table-field-name:`restricted` - :action-table-field-type:`bool` - :action-table-field-example:`true` - True if the User that attempted the login was a restricted User, false otherwise. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`successful` - Whether the login attempt succeeded or failed. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`example_user` - The username of the User that attempted the login. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_maintenance-list: `maintenance-list `_ -------------------------------------------------------------------------------------- Returns a collection of Maintenance objects for any entity a user has permissions to view. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account maintenance-list [-h] [--type type] [--when when] [--status status] [--order-by {type,when,status}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account maintenance-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-status` - :action-table-field-type:`str` - The maintenance status. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - The type of maintenance. * - :action-table-field-name:`\-\-when` - :action-table-field-type:`str` - When the maintenance will begin. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`reason` - :action-table-field-type:`str` - :action-table-field-example:`This mainten...motherboard.` - The reason maintenance is being performed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`started` - The maintenance status. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`reboot` - The type of maintenance. * - :action-table-field-name:`when` - :action-table-field-type:`str` - :action-table-field-example:`2020-07-09T00:01:01` - When the maintenance will begin. .. _commands_account_maintenance-list_attribute_sections_entity: .. rst-class:: action-section-header entity .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`entity.id` - :action-table-field-type:`float` - :action-table-field-example:`1234` - The id of the entity being affected by maintenance. * - :action-table-field-name:`entity.label` - :action-table-field-type:`str` - :action-table-field-example:`demo-linode` - The label of the entity being affected by maintenance. * - :action-table-field-name:`entity.type` - :action-table-field-type:`str` - :action-table-field-example:`Linode` - The type of entity. * - :action-table-field-name:`entity.url` - :action-table-field-type:`str` - :action-table-field-example:`https://api.l...s/{linodeId}` - The API endpoint prefix to use in combination with the entity id to find specific information about the entity. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_notifications-list: `notifications-list `_ ------------------------------------------------------------------------------------------ Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account notifications-list [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account notifications-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`body` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A full description of this Notification, in markdown format. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`You have an ...ticket open!` - A short description of this Notification. * - :action-table-field-name:`message` - :action-table-field-type:`str` - :action-table-field-example:`You have an ...ticket open!` - A human-readable description of the Notification. * - :action-table-field-name:`severity` - :action-table-field-type:`str` - :action-table-field-example:`major` - The severity of this Notification. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`ticket_important` - The type of Notification this is. * - :action-table-field-name:`until` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - If this Notification has a duration, this will be the ending time for the Event/action. * - :action-table-field-name:`when` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. .. _commands_account_notifications-list_attribute_sections_entity: .. rst-class:: action-section-header entity .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`entity.id` - :action-table-field-type:`int` - :action-table-field-example:`3456` - The unique ID of the Notification's entity, based on the entity type. * - :action-table-field-name:`entity.label` - :action-table-field-type:`str` - :action-table-field-example:`Linode not booting.` - The current label for this Notification's entity. * - :action-table-field-name:`entity.type` - :action-table-field-type:`str` - :action-table-field-example:`ticket` - The type of entity this is related to. * - :action-table-field-name:`entity.url` - :action-table-field-type:`str` - :action-table-field-example:`/support/tickets/3456` - The URL where you can access the object this Notification is for. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_payment-view: `payment-view `_ ------------------------------------------------------------------------------ Returns information about a specific Payment. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account payment-view [-h] [--order-by {}] [--order {asc,desc}] paymentId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account payment-view 123 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`paymentId` - :action-table-field-type:`int` - The ID of the Payment to look up. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`date` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - When the Payment was made. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the Payment. * - :action-table-field-name:`usd` - :action-table-field-type:`int` - :action-table-field-example:`120.50` - The amount, in US dollars, of the Payment. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_payment-create: `payment-create `_ --------------------------------------------------------------------------------- Makes a Payment to your Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account payment-create [-h] [--usd usd] [--payment_method_id payment_method_id] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account payment-create \ --usd 120.50 \ --payment_method_id 123 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-payment_method_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Payment Method to apply to the Payment. * - :action-table-field-name:`\-\-usd` - :action-table-field-type:`str` - :action-table-field-example:`$120.50` - The amount in US Dollars of the Payment. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`date` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - When the Payment was made. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the Payment. * - :action-table-field-name:`usd` - :action-table-field-type:`int` - :action-table-field-example:`120.50` - The amount, in US dollars, of the Payment. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_payments-list: `payments-list `_ -------------------------------------------------------------------------------- Returns a paginated list of Payments made on this Account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account payments-list [-h] [--order-by {}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account payments-list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`date` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - When the Payment was made. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the Payment. * - :action-table-field-name:`usd` - :action-table-field-type:`int` - :action-table-field-example:`120.50` - The amount, in US dollars, of the Payment. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_promo-add: `promo-add `_ --------------------------------------------------------------------------------- Adds an expiring Promo Credit to your account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account promo-add [-h] [--promo_code promo_code] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account \ promo-add \ --promo-code abcdefABCDEF1234567890 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-promo_code` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The Promo Code. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`credit_monthly_cap` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount available to spend per month. * - :action-table-field-name:`credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`50.00` - The total amount of credit left for this promotion. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`Receive up to...period ends.` - A detailed description of this promotion. * - :action-table-field-name:`expire_dt` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-31T23:59:59` - When this promotion's credits expire. * - :action-table-field-name:`image_url` - :action-table-field-type:`str` - :action-table-field-example:`https://linod...romotion.svg` - The location of an image for this promotion. * - :action-table-field-name:`service_type` - :action-table-field-type:`str` - :action-table-field-example:`all` - The service to which this promotion applies. * - :action-table-field-name:`summary` - :action-table-field-type:`str` - :action-table-field-example:`$10 off your...ode a month!` - Short details of this promotion. * - :action-table-field-name:`this_month_credit_remaining` - :action-table-field-type:`str` - :action-table-field-example:`10.00` - The amount of credit left for this month for this promotion. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_account_settings-update: `settings-update `_ ------------------------------------------------------------------------------------------ Updates your account settings. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli account settings-update [-h] [--backups_enabled backups_enabled] [--network_helper network_helper] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli account settings-update \ --network_helper false .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-backups_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Account-wide backups default. * - :action-table-field-name:`\-\-network_helper` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Enables network helper across all users by default for new Linodes and Linode Configs. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`backups_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Account-wide backups default. * - :action-table-field-name:`longview_subscription` - :action-table-field-type:`str` - :action-table-field-example:`longview-3` - The Longview Pro tier you are currently subscribed to. * - :action-table-field-name:`managed` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Our 24/7 incident response service. * - :action-table-field-name:`network_helper` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Enables network helper across all users by default for new Linodes and Linode Configs. * - :action-table-field-name:`object_storage` - :action-table-field-type:`str` - :action-table-field-example:`active` - A string describing the status of this account's Object Storage service enrollment.