Expand description

The data types sent to and returned from the API client.

Structs

Client view of an Disk

Create-time parameters for a Disk

Parameters for the Disk to be attached or detached to an instance

A single page of results

The name and type information for a field of a timeseries schema.

Client view of an Instance

Create-time parameters for an Instance

A single page of results

A NetworkInterface represents a virtual network interface device.

A single page of results

A single page of results

Updateable properties of an [Organization]

Client view of a Project

Create-time parameters for a Project

A single page of results

Updateable properties of a Project

Client view of an Rack

A single page of results

Client view of a Role

A single page of results

A route defines a rule that governs where traffic should be sent based on its destination.

Create-time parameters for a RouterRoute

A single page of results

Updateable properties of a RouterRoute

A single page of results

Client view of currently authed user.

Client view of an Sled

A single page of results

The schema for a timeseries.

A single page of results

Client view of a User

A single page of results

Client view of a Vpc

Create-time parameters for a Vpc

A single rule in a VPC firewall

Filter for a firewall rule. A given packet must match every field that is present for the rule to apply to it. A packet matches a field if any entry in that field matches the packet.

A single page of results

A single rule in a VPC firewall

A single page of results

A VPC router defines a series of rules that indicate where traffic should be sent depending on its destination.

A single page of results

Updateable properties of a VpcRouter

A VPC subnet represents a logical grouping for instances that allows network traffic between them, within a IPv4 subnetwork or optionall an IPv6 subnetwork.

Create-time parameters for a VpcSubnet

A single page of results

Updateable properties of a VpcSubnet

Updateable properties of a Vpc

Enums

  • The type of an individual datum of a metric.
  • The source from which a field is derived, the target or metric.
  • The FieldType identifies the data type of a target or metric field.
  • Supported set of sort modes for scanning by id only.
  • Currently, we only support scanning in ascending order.
  • Running state of an Instance (primarily: booted or stopped)
  • This typically reflects whether it’s starting, running, stopping, or stopped, but also includes states related to the Instance’s lifecycle
  • Supported set of sort modes for scanning by name or id
  • Supported set of sort modes for scanning by name only
  • Currently, we only support scanning in ascending order.
  • The classification of a RouterRoute as defined by the system. The kind determines certain attributes such as if the route is modifiable and describes how or where the route was created.
  • See RFD-21 for more context
  • The protocols that may be specified in a firewall rule’s filter