View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Account

Notifications List

get
https://api.linode.com/v4/account/notifications

Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. You cannot interact directly with Notifications, and a Notification will disappear when the circumstances causing it have been resolved. For example, if you have an important Ticket open, you must respond to the Ticket to dismiss the Notification.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/account/notifications

Response Samples

{
  "data": [
    {
      "entity": {
        "id": 3456,
        "label": "Linode not booting.",
        "type": "ticket",
        "url": "/support/tickets/3456"
      },
      "message": "You have an important ticket open!",
      "label": "You have an important ticket open!",
      "type": "ticket_important",
      "when": "",
      "body": "",
      "severity": "major",
      "until": ""
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns a paginated list of Notification objects.

data
array of objects
entity
object

Detailed information about the Notification.

id
Nullable
integer

The unique ID of the Notification's entity, based on the entity type.

Returns null for the following entity types:

  • account
  • promotion
label
Nullable
string

The current label for this Notification's entity.

Returns null for the following entity types:

  • entity_transfer
  • promotion
  • region
type
string
Enum: "account""entity_transfer""linode""nodebalancer""promotion""region""ticket""volume"

The type of entity this is related to.

url
Nullable
string

The URL where you can access the object this Notification is for. If a relative URL, it is relative to the domain you retrieved the Notification from.

Returns null for the promotion entity type.

message
string

A human-readable description of the Notification.

label
string

A short description of this Notification.

type
string
Enum: "migration_scheduled""migration_imminent""migration_pending""reboot_scheduled""outage""payment_due""ticket_important""ticket_abuse""notice""maintenance""promotion"

The type of Notification this is.

when
string

If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.

body
Nullable
string

A full description of this Notification, in markdown format. Not all Notifications include bodies.

severity
string
Enum: "minor""major""critical"

The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.

until
string

If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, until would be set to the end of the maintenance window.

page
integer

The current page.

pages
integer

The total number of pages.

results
integer

The total number of results.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.