Parameters
#organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
Your account identity and requested details.
Show 13 attributesHide attributes
account_idstringAlways present
Selected account's ID.
addressesobject
Static addresses held by the account. May be omitted.
Show 2 attributesHide attributes
addressesobject[] | nullAlways present
Addresses in the selected scope and their attachments.
Show 1 attributeHide attributes
itemsobject
A static IPv4 address and its attachment.
Show 10 attributesHide attributes
accountboolean
Whether this is the account's default address for pools in this placement. May be omitted.
addressstringAlways present
Static IPv4 address.
available_fromstring (date-time)
When a released address becomes available to another account. May be omitted.
bought_atstring (date-time)Always present
When the account acquired the address.
computerstring
Attached Computer's name. May be omitted.
computer_idstring
Attached Computer's ID. May be omitted.
poolstring
Attached pool's name. May be omitted.
pool_idstring
Attached pool's ID. May be omitted.
regionstringAlways present
Address's region.
released_atstring (date-time)
When the address was released. May be omitted.
limitintegerAlways present
Account's static-address allowance.
api_keysobject
API key metadata. May be omitted.
Show 1 attributeHide attributes
api_keysobject[] | nullAlways present
Key metadata, permissions and lifetime.
Show 1 attributeHide attributes
itemsobject
An API key's identity, permissions and lifetime.
Show 13 attributesHide attributes
cmdsstring[] | nullAlways present
Permitted commands, subject to your permissions.
* permits all commands for a sign-in key.computer_namesmap<string, string>
Names of the Computers its scope names, by ID, those its organization still has. May be omitted.
created_atstring (date-time)Always present
When the key was created.
expires_atstring (date-time) | nullAlways present
When the key expires, or null if it has no expiry.
idstringAlways present
Key ID for editing, rotation or revocation.
labelstringAlways present
User-assigned label.
last_used_atstring (date-time) | nullAlways present
Last recorded use, or null if no use has been recorded.
organizationstring
Organization the key acts in. Sign-in keys can omit this to select an organization per request. May be omitted.
previous_secret_expires_atstring (date-time)
Expiry of the replaced secret, included while it remains accepted. May be omitted.
revoked_atstring (date-time) | nullAlways present
When the key was revoked, or null if it has not been revoked.
rotated_atstring (date-time) | nullAlways present
When its secret was last rotated, or null if it has not been rotated.
scopeobject
Resource restrictions in addition to your permissions. An absent scope adds no restriction. May be omitted.
Show 3 attributesHide attributes
computersstring[]
Computer IDs included in the key's scope. May be omitted.
poolsstring[]
Pool IDs included in the key's scope. May be omitted.
tagsstring[]
Tags selecting Computers the key can reach. May be omitted.
tokenstring
Newly issued secret, returned only on creation or rotation. May be omitted.
billingobject
Selected account's billing details. May be omitted.
Show 27 attributesHide attributes
auto_topup_centsinteger
Automatic top-up amount in cents. May be omitted.
auto_topup_monthly_limit_centsintegerAlways present
Monthly automatic top-up ceiling, in cents.
balance_microsintegerAlways present
Total remaining wallet credit, in millionths of a dollar.
can_managebooleanAlways present
Whether you can manage this account's billing.
cardobject
Saved payment card. May be omitted.
Show 4 attributesHide attributes
brandstring
Card brand reported by the payment provider. May be omitted.
exp_monthinteger
Expiration month, from 1 through 12. May be omitted.
exp_yearinteger
Four-digit expiration year. May be omitted.
last4stringAlways present
Last four digits of the card number.
card_formboolean
Whether the card setup form is available. May be omitted.
card_savedbooleanAlways present
Whether a payment card is saved.
contactsstring[]
Additional recipients of billing email. May be omitted.
egressobject
This month's outbound traffic usage, charges and cap. May be omitted.
Show 12 attributesHide attributes
allowance_bytesintegerAlways present
Internet egress included for the month, in bytes.
capstringAlways present
Egress cap setting:
default, amount or off.cap_microsinteger
Monthly cap in millionths of a dollar. Absent when the cap is off. May be omitted.
charged_microsintegerAlways present
Egress charged so far this month, in millionths of a dollar.
chargingbooleanAlways present
Whether egress overage is currently billed.
monthstring (date-time)Always present
Month being measured.
not_charged_bytesinteger
Overage bytes not charged while the wallet was past its grace period. May be omitted.
over_bytesintegerAlways present
Usage above the included allowance, in bytes.
projected_bytesintegerAlways present
Estimated monthly egress based on use so far, in bytes.
slowedbooleanAlways present
Whether the account's internet egress is currently slowed because of its egress cap, its spending cap or its wallet state.
used_bytesintegerAlways present
Internet egress used this month, in bytes.
would_charge_microsinteger
What overage would cost if charging were enabled, in millionths of a dollar. May be omitted.
entriesobject[] | nullAlways present
Recent wallet ledger entries.
Show 1 attributeHide attributes
itemsobject
One wallet ledger entry.
Show 4 attributesHide attributes
amount_microsintegerAlways present
Signed change in wallet balance, in millionths of a dollar.
atstring (date-time)Always present
When the entry was recorded.
kindstringAlways present
Reason for the credit or debit.
poolstring
Pool associated with the entry, when present. May be omitted.
heldboolean
Whether billing has placed the account on hold. May be omitted.
lasts_hoursnumber
Estimated wallet lifetime in hours at current spending. May be omitted.
next_renewalstring (date-time)
When the next monthly renewal is due. May be omitted.
noticesstring[] | nullAlways present
Billing issues or changes needing attention.
paid_microsintegerAlways present
Remaining purchased wallet credit, in millionths of a dollar.
pay_bystring
Account's payment method. May be omitted.
payments_offboolean
Whether payments are disabled. May be omitted.
per_hour_microsintegerAlways present
Hourly wallet spending, in millionths of a dollar.
promo_expiringobject[]
Promotional credits expiring soon. May be omitted.
Show 1 attributeHide attributes
itemsobject
A wallet credit grant.
Show 8 attributesHide attributes
amount_microsintegerAlways present
Original credit amount in millionths of a dollar.
created_atstring (date-time)Always present
When the credit was granted.
expires_atstring (date-time)
When unused credit expires, if an expiry is set. May be omitted.
idstringAlways present
Credit grant's ID.
refundablebooleanAlways present
Whether this credit is eligible for a refund.
remaining_microsintegerAlways present
Credit still available, in millionths of a dollar.
scopestring[]
Spending categories this credit can pay for. May be omitted.
sourcestringAlways present
Origin of this credit.
promo_microsintegerAlways present
Remaining promotional wallet credit, in millionths of a dollar.
purchasesobject[] | nullAlways present
Purchases being billed and any scheduled changes.
Show 1 attributeHide attributes
itemsobject
A billed capacity purchase and its pending changes.
Show 11 attributesHide attributes
amount_microsintegerAlways present
Price per billing period, in millionths of a dollar.
changestring
Scheduled change to this purchase. May be omitted.
change_atstring (date-time)
When the scheduled change takes effect. May be omitted.
change_planinteger
Plan selected by a scheduled resize. May be omitted.
idstringAlways present
Capacity purchase ID.
modelstringAlways present
Billing model.
pendingboolean
Whether the first payment is pending. May be omitted.
planintegerAlways present
Purchased plan number.
poolsstring[] | nullAlways present
Pools that can use capacity from this purchase.
regionstring
Purchase's region. May be omitted.
switch_saves_microsinteger
Estimated monthly savings from switching to monthly billing, in millionths of a dollar. May be omitted.
renewal_microsintegerAlways present
Account's monthly renewal total, in millionths of a dollar.
spend_alert_microsinteger | nullAlways present
Monthly spending alert threshold in millionths of a dollar; null disables alerts.
spending_cap_microsinteger | nullAlways present
Monthly spending cap in millionths of a dollar, past which nothing is charged; null for none.
subscription_statusstring
Payment provider's current subscription state. May be omitted.
time_zonestringAlways present
Account's time zone for billing communications.
usage_emailsbooleanAlways present
Whether monthly usage emails are enabled.
defaultsobject
Default setup script. May be omitted.
Show 1 attributeHide attributes
valuestringAlways present
Saved script text. An empty value means no account default is set.
emailstring
Your verified email address, when one is recorded. May be omitted.
invitationsobject[]
Invitations you can accept or decline. May be omitted.
Show 1 attributeHide attributes
itemsobject
An organization or team invitation awaiting your decision.
Show 9 attributesHide attributes
expires_atstring (date-time)Always present
When the invitation expires.
idstringAlways present
Invitation ID.
invited_bystring
Inviter's email, when a person sent it. May be omitted.
invited_by_namestring
Inviter's display name, when available. May be omitted.
organizationstringAlways present
Organization the invitation joins.
rolestringAlways present
Offered organization role.
teamstring
Team being joined, as
ORGANIZATION@TEAM. May be omitted.team_rolestring
Offered team role, when applicable. May be omitted.
teamsstring[]
Additional teams included in the invitation. May be omitted.
namestring | nullAlways present
Your saved display name, or null without one.
picturestring | nullAlways present
Your profile picture URL, or null without one.
ssh_keysobject
Registered SSH keys. May be omitted.
Show 1 attributeHide attributes
keysobject[] | nullAlways present
Each key's identity and any Computer or tag restriction.
Show 1 attributeHide attributes
itemsobject
A registered SSH public key and its access restrictions.
Show 8 attributesHide attributes
computerobject
Single Computer this key can reach, when it is limited to one. May be omitted.
Show 2 attributesHide attributes
idstringAlways present
Selected Computer's ID.
namestringAlways present
Current name; empty during deletion or after you lose access.
created_atstring (date-time)
Time the key was added. May be omitted.
fingerprintstringAlways present
Public key fingerprint.
idstringAlways present
Registered key's ID.
labelstringAlways present
User-assigned label.
last_used_atstring (date-time) | nullAlways present
Last recorded SSH sign-in; null if none is recorded. Updates can take five minutes.
public_keystringAlways present
SSH public key.
tagstring
Tag limiting the key to matching Computers, when set. May be omitted.
user_idstringAlways present
Your user ID.
withheldstring[]
Requested parts that your credential or role cannot read. May be omitted.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
account view.