Expand description
The data types sent to and returned from the API client.
Structs§
- Bindouble
- Type storing bin edges and a count of samples within it.
- Binint64
- Type storing bin edges and a count of samples within it.
- Cumulativedouble
- A cumulative or counter data type.
- Cumulativeint64
- A cumulative or counter data type.
- DerEncoded
KeyPair - Device
Access Token Request - Device
Auth Request - Device
Auth Verify - Disk
- Client view of a
Disk - Disk
Create - Create-time parameters for a
Disk - Disk
Identifier - Parameters for the
Diskto be attached or detached to an instance - Disk
Results Page - A single page of results
- Distribution
- OS image distribution
- Error
Response - Error information from a response.
- External
Ip - External
IpResults Page - A single page of results
- Field
Schema - The name and type information for a field of a timeseries schema.
- Fleet
Role Assignment - Describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
- Fleet
Role Policy - Client view of a [
Policy], which describes how this resource may be accessed - Global
Image - Client view of global Images
- Global
Image Create - Create-time parameters for an
GlobalImage - Global
Image Results Page - A single page of results
- Histogramdouble
- A simple type for managing a histogram metric.
- Histogramint64
- A simple type for managing a histogram metric.
- Identity
Provider - Client view of an
IdentityProvider - Identity
Provider Results Page - A single page of results
- Image
- Client view of project Images
- Image
Create - Create-time parameters for an
Image - Image
Results Page - A single page of results
- Instance
- Client view of an
Instance - Instance
Create - Create-time parameters for an
Instance - Instance
Migrate - Migration parameters for an
Instance - Instance
Results Page - A single page of results
- Instance
Serial Console Data - Contents of an Instance’s serial console buffer.
- IpPool
- Identity-related metadata that’s included in nearly all public API objects
- IpPool
Create - Create-time parameters for an IP Pool.
- IpPool
Range - IpPool
Range Results Page - A single page of results
- IpPool
Results Page - A single page of results
- IpPool
Update - Parameters for updating an IP Pool
- Ipv4Net
- An
Ipv4Netrepresents a IPv4 subnetwork, including the address and network mask. - Ipv4
Range - A non-decreasing IPv4 address range, inclusive of both ends.
- Ipv6Net
- An
Ipv6Netrepresents a IPv6 subnetwork, including the address and network mask. - Ipv6
Range - A non-decreasing IPv6 address range, inclusive of both ends.
- Measurement
- A
Measurementis a timestamped datum from a single metric - Measurement
Results Page - A single page of results
- Network
Interface - A
NetworkInterfacerepresents a virtual network interface device. - Network
Interface Create - Create-time parameters for a
NetworkInterface - Network
Interface Results Page - A single page of results
- Network
Interface Update - Parameters for updating a
NetworkInterface. - Organization
- Client view of an
Organization - Organization
Create - Create-time parameters for an
Organization - Organization
Results Page - A single page of results
- Organization
Role Assignment - Describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
- Organization
Role Policy - Client view of a [
Policy], which describes how this resource may be accessed - Organization
Update - Updateable properties of an
Organization - Project
- Client view of a
Project - Project
Create - Create-time parameters for a
Project - Project
Results Page - A single page of results
- Project
Role Assignment - Describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
- Project
Role Policy - Client view of a [
Policy], which describes how this resource may be accessed - Project
Update - Updateable properties of a
Project - Rack
- Client view of an
Rack - Rack
Results Page - A single page of results
- Role
- Client view of a
Role - Role
Results Page - A single page of results
- Router
Route - A route defines a rule that governs where traffic should be sent based on its destination.
- Router
Route Create Params - Create-time parameters for a
RouterRoute - Router
Route Results Page - A single page of results
- Router
Route Update Params - Updateable properties of a
RouterRoute - Saga
- Saga
Results Page - A single page of results
- Saml
Identity Provider - Identity-related metadata that’s included in nearly all public API objects
- Saml
Identity Provider Create - Create-time identity-related parameters
- Silo
- Client view of a [‘Silo’]
- Silo
Create - Create-time parameters for a
Silo - Silo
Results Page - A single page of results
- Silo
Role Assignment - Describes the assignment of a particular role on a particular resource to a particular identity (user, group, etc.)
- Silo
Role Policy - Client view of a [
Policy], which describes how this resource may be accessed - Sled
- Client view of an
Sled - Sled
Results Page - A single page of results
- Snapshot
- Client view of a Snapshot
- Snapshot
Create - Create-time parameters for a
Snapshot - Snapshot
Results Page - A single page of results
- Spoof
Login Body - SshKey
- Client view of a
SshKey - SshKey
Create - Create-time parameters for an
SshKey - SshKey
Results Page - A single page of results
- Timeseries
Schema - The schema for a timeseries.
- Timeseries
Schema Results Page - A single page of results
- User
- Client view of a
User - User
Builtin - Client view of a
UserBuiltin - User
Builtin Results Page - A single page of results
- User
Results Page - A single page of results
- Vpc
- Client view of a
Vpc - VpcCreate
- Create-time parameters for a
Vpc - VpcFirewall
Rule - A single rule in a VPC firewall
- VpcFirewall
Rule Filter - 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.
- VpcFirewall
Rule Update - A single rule in a VPC firewall
- VpcFirewall
Rule Update Params - Updateable properties of a
Vpc’s firewall Note that VpcFirewallRules are implicitly created along with a Vpc, so there is no explicit creation. - VpcFirewall
Rules - Collection of a Vpc’s firewall rules
- VpcResults
Page - A single page of results
- VpcRouter
- A VPC router defines a series of rules that indicate where traffic should be sent depending on its destination.
- VpcRouter
Create - Create-time parameters for a
VpcRouter - VpcRouter
Results Page - A single page of results
- VpcRouter
Update - Updateable properties of a
VpcRouter - VpcSubnet
- A VPC subnet represents a logical grouping for instances that allows network traffic between them, within a IPv4 subnetwork or optionall an IPv6 subnetwork.
- VpcSubnet
Create - Create-time parameters for a
VpcSubnet - VpcSubnet
Results Page - A single page of results
- VpcSubnet
Update - Updateable properties of a
VpcSubnet - VpcUpdate
- Updateable properties of a
Vpc
Enums§
- BinRangedouble
- BinRangedouble
Type - The types for BinRangedouble.
- BinRangeint64
- BinRangeint64
Type - The types for BinRangeint64.
- Datum
- Datum
Type - The type of an individual datum of a metric.
- Digest
- Digest
Type - The types for Digest.
- Disk
Metric Name - Disk
Source - Disk
Source Type - The types for DiskSource.
- Disk
State - Disk
State Type - The types for DiskState.
- Error
- External
IpCreate - External
IpCreate Type - The types for ExternalIpCreate.
- Field
Source - The source from which a field is derived, the target or metric.
- Field
Type - The
FieldTypeidentifies the data type of a target or metric field. - Fleet
Role - IdSort
Mode - Supported set of sort modes for scanning by id only.
- Identity
Provider Type - Identity
Provider Type Saml - Identity
Type - Describes what kind of identity is described by an id
- IdpMetadata
Source - IdpMetadata
Source Type - The types for IdpMetadataSource.
- Image
Source - Image
Source Type - The types for ImageSource.
- Instance
Disk Attachment - Instance
Disk Attachment Type - The types for InstanceDiskAttachment.
- Instance
Network Interface Attachment - Instance
Network Interface Attachment Type - The types for InstanceNetworkInterfaceAttachment.
- Instance
State - Running state of an Instance (primarily: booted or stopped)
- IpKind
- The kind of an external IP address for an instance
- IpNet
- An
IpNetrepresents an IP network, either IPv4 or IPv6. - IpRange
- Name
OrId Sort Mode - Supported set of sort modes for scanning by name or id
- Name
Sort Mode - Supported set of sort modes for scanning by name only
- Organization
Role - Project
Role - Resource
Type - Identifies a type of API resource
- Route
Destination - Route
Destination Type - The types for RouteDestination.
- Route
Target - Route
Target Type - The types for RouteTarget.
- Router
Route Kind - The classification of a
RouterRouteas 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. - Saga
Error Info - Saga
Error Info Type - The types for SagaErrorInfo.
- Saga
State - Saga
State Type - The types for SagaState.
- Silo
Role - User
Provision Type - How users will be provisioned in a silo during authentication.
- VpcFirewall
Rule Action - VpcFirewall
Rule Direction - VpcFirewall
Rule Host Filter - VpcFirewall
Rule Host Filter Type - The types for VpcFirewallRuleHostFilter.
- VpcFirewall
Rule Protocol - The protocols that may be specified in a firewall rule’s filter
- VpcFirewall
Rule Status - VpcFirewall
Rule Target - VpcFirewall
Rule Target Type - The types for VpcFirewallRuleTarget.
- VpcRouter
Kind
Type Aliases§
- Block
Size - Byte
Count - A count of bytes, typically used either for memory or storage capacity
- Instance
CpuCount - The number of CPUs in an Instance
- L4Port
Range - An inclusive-inclusive range of IP ports. The second port may be omitted to represent a single port
- MacAddr
- A Media Access Control address, in EUI-48 format
- Name
- Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
- Node
Name - Unique name for a saga [
Node] - Role
Name - Role names consist of two string components separated by dot (“.”).
- Timeseries
Name - Names are constructed by concatenating the target and metric names with ‘:’. Target and metric names must be lowercase alphanumeric characters with ‘_’ separating words.