OBJECT
Query
link GraphQL Schema definition
- type Query {
- String :
- String :
- # Retrieves your account details
- User :
- # Lists all public keys we have on record for the specified account
- #
- # Arguments
- # name: name of the key to filter
- String): [Key] ( :
- # Retrieves the record for an individual key
- #
- # Arguments
- # name: name of the key to retrieve
- String!): Key ( :
- # Returns a list of an account's user objects
- #
- # Arguments
- # id: user id to filter
- ID): [User] ( :
- # Get one user for an account
- #
- # Arguments
- # id: username of user to filter
- ID!): User ( :
- # Returns an array of account roles
- #
- # Arguments
- # id: filter by role `id`
- # name: filter by role `name`
- ID, : String): [Role] ( :
- # Get an account role (`:role`) by `id` or `name`
- #
- # Arguments
- # id: retrieve role with `id`
- # name: retrieve role with `name`
- ID, : String): Role ( :
- # Retrieves a list of account policies
- #
- # Arguments
- # id: filter by policy `id`
- ID): [Policy] ( :
- # Get an account policy (`:policy`) by `id`
- #
- # Arguments
- # id: retrieve policy with `id`
- ID!): Policy ( :
- # Outputs configuration for your account
- KeyValue] : [
- # Retrieve either a datacenter by name, or omit the name and retrieve the current
- #
- # Arguments
- # name:
- String): Datacenter ( :
- # Provides a list of all datacenters this cloud is aware of
- Datacenter] : [
- # Provides the URL endpoints for services for this datacenter. It is a mapping of
- # service name to URL endpoint.
- KeyValue] : [
- # Provides a list of images available in this datacenter
- #
- # Arguments
- # id: The id of this image
- # name: The "friendly" name for this image
- # os: The underlying operating system for this image
- # version: The version for this image
- # public: Filter public/private images
- # state: Filter on image state. By default only active images are
- # shown. Use ALL to list all images
- # owner: Filter on owner UUID
- # type: Filter on image type
- (
- ID, :
- String, :
- ImageOS, :
- String, :
- Boolean, :
- ImageState, :
- ID, :
- ImageType :
- ): [Image]
- # Gets an individual image by id
- #
- # Arguments
- # id: Unique id of this image
- ID): Image ( :
- # Provides a list of packages available in this datacenter
- #
- # Arguments
- # id: The id of for this package
- # name: The "friendly" name for this package
- # memory: How much memory will by available (in MiB)
- # disk: How much disk space will be available (in MiB)
- # swap: How much swap space will be available (in MiB)
- # lwps: Maximum number of light-weight processes (threads)
- # allowed
- # vcpus: Number of vCPUs for this package
- # version: The version of this package
- # group: The group this package belongs to
- (
- ID, :
- String, :
- Int, :
- Int, :
- Int, :
- Int, :
- Int, :
- String, :
- String :
- ): [Package]
- # Gets a package by `name` or `id`
- #
- # Arguments
- # id: The id of for this package
- # name: The "friendly" name for this package
- ID, : String): Package ( :
- # Lists all instances we have on record for your account
- #
- # Arguments
- # id: The id of for this machine
- # brand: The type of instance (e.g. lx)
- # name: Machine name to find (will make your list size 1, or 0 if
- # nothing found)
- # image: Image id; returns instances provisioned with that image
- # state: The current state of the instance (e.g. running)
- # memory: The current size of the RAM deployed for the instance
- # (in MiB)
- # tombstone: Include destroyed and failed instances available in
- # instance history
- # limit: Return a max of N instances; default is 1000 (which is
- # also the maximum allowable result set size)
- # offset: Get a limit number of instances starting at this offset
- # docker: Whether to only list Docker instances, or only
- # non-Docker instances, if present. Defaults to showing all instances
- # credentials: Whether to include the generated credentials for
- # instances, if present. Defaults to false
- # tags: An arbitrary set of tags can be used for querying
- (
- ID, :
- Brand, :
- String, :
- ID, :
- MachineState, :
- Int, :
- Boolean, :
- Int, :
- Int, :
- Boolean, :
- Boolean, :
- KeyValueInput] : [
- ): MachinePage
- # Gets the details for an individual instance. Deleted instances are returned only
- # if the instance history has not been purged from Triton
- #
- # Arguments
- # id: The id of for this machine
- ID): Machine ( :
- # Lists all snapshots taken for a given machine
- #
- # Arguments
- # name: Snapshot id
- # machine: Machine id
- ID, : ID!): [Snapshot] ( :
- # Gets the state of the named snapshot
- #
- # Arguments
- # machine: Machine id
- # name: Snapshot name
- ID!, : String!): Snapshot ( :
- # Returns the complete set of metadata associated with a given machine
- #
- # Arguments
- # machine: Machine id
- # credentials: Whether or not to return instance credentials.
- # Defaults to false
- # name: Name of metadata value to retrieve
- ID!, : Boolean, : String): [KeyValue] ( :
- # Gets the value of a named metadata
- #
- # Arguments
- # machine: Machine id
- # name: Name of metadata value to retrieve
- ID!, : String): KeyValue ( :
- # Returns the complete set of tags associated with this machine
- #
- # Arguments
- # machine: Machine id
- # name: Name of tag value to retrieve
- ID!, : String): [KeyValue] ( :
- # Returns the value for a single tag on this machine
- #
- # Arguments
- # machine: Machine id
- # name: Name of tag value to retrieve
- ID!, : String): KeyValue ( :
- # Provides a list of an instance's accomplished actions. Results are sorted from
- # newest to oldest action. Note that the complete audit trail is returned only if
- # the instance history and job records have not been purged from Triton.
- #
- # Arguments
- # machine: Machine id
- ID!): [Action] ( :
- # List all firewall rules for the current account
- #
- #
- # Arguments
- #
- # id:
- #
- # machine:
- #
- # Arguments
- # id: Unique identifier for this rule
- # machine: Machine id
- ID, : ID): [FirewallRule] ( :
- # Retrieves an individual firewall rule
- #
- # Arguments
- # id: Unique identifier for this rule
- ID!): FirewallRule ( :
- # temporary!!
- #
- # Arguments
- # tags:
- (
- KeyValueInput] : [
- ): [CreateMachineFirewallRule]
- # List all vlans for the current account
- #
- # Arguments
- # id: Unique identifier for this vlan
- Int): [VLAN] ( :
- # Retrieves an individual vlan
- #
- # Arguments
- # id: Unique identifier for this vlan
- Int!): VLAN ( :
- # Lists all of the networks. If the vlan parameter is specified, then only fabric
- # networks are returned
- #
- # Arguments
- # id:
- # vlan: VLAN id
- ID, : Int): [Network] ( :
- # Retrieves an individual network rule
- #
- # Arguments
- # id:
- # vlan: VLAN id
- ID!, : Int): Network ( :
- # List all the NICs on an instance
- #
- # Arguments
- # machine: Machine id
- # mac: NIC's MAC address
- ID!, : String): [NIC] ( :
- # Gets a specific NIC on an instance
- #
- # Arguments
- # machine: Machine id
- # mac: NIC's MAC address
- ID!, : String!): NIC ( :
- }
link Require by
This element is not required by anyone