llms.txt
Compare with other sites' llms.txt files →# https://api.asergo.com/v1/schema llms.txt
- [API Schema Overview](https://api.asergo.com/v1/schema): API schema for managing actions, tickets, and user permissions.
##Schema
"Shared Action result, holds status for actions invoked"
type ActionPayload {
"Indicates the requested action was successful"
success: Boolean!
"Additional information about the result"
information: String
"Warnings related to the completed action"
warning: String
"Errors occured dureing the action"
error: String
}
"Content of a new ticket entry"
input AddTicketResponseInput {
"Ticket ID"
id: TicketId!
"Content of message (In HTML)"
body: String!
"Attachments"
attachment: [AttachmentCreate!]
}
"Result for a message reply "
type AddTicketResponsePayload {
ticket: Ticket
}
"""
Address details
Object identified by parent object ID.
"""
type Address {
street: String!
street2: String!
city: String!
country: CountryISO
zip: String
"Country as string value"
countryString(
"Locale string see [javadocs](https://commons.apache.org/proper/commons-lang/javadocs/api-3.6/org/apache/commons/lang3/LocaleUtils.html#toLocale-java.lang.String-)"
locale: String): String
}
"""
Updates for an address.
Only fields supplied are updated
"""
input AddressUpdate {
"Street update"
street: String
street2: String
"City"
city: String
"Country"
country: CountryISO
"Zip"
zip: String
}
"Cpu architecture"
enum Architecture {
X386
Amd64
Other
Unknown
}
"Attachment details and content"
type Attachment {
id: AttachmentId!
updated: Timestamp!
"Human readable label for the attachment"
displayName: String!
"The filename, eg. logs.log"
filename: String!
mimetype: String!
created(
"Timezone eg. Europe/Copenhagen, America/Toronto, Etc/GMT+1, +01:00"
timezone: TimeZone,
"\n Time pattern in java format\n see [Patterns for Formatting and Parsing](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)\n Default pattern is: `yyyy-MM-dd'T'HH:mm:ssZ`\n\n ### Reserved formatting words:\n | Format name | Example |\n |---------|---------|\n | ISO_DATE | 2017-06-20+02:00 |\n | ISO_DATE_TIME | 2017-06-15T22:35:50.247+02:00[Europe/Copenhagen] |\n | ISO_TIME | 22:35:50.247+02:00|\n | ISO_LOCAL_DATE | 2017-06-18|\n | ISO_LOCAL_DATE_TIME | 2011-12-03T10:15:30|\n | BASIC_ISO_DATE | 20170620+0200|\n | RFC_1123_DATE_TIME | Tue, 20 Jun 2017 01:17:50 +0200|\n | LOCALIZED-DATE-TIME-SHORT | 13/06/17 17:43|\n | LOCALIZED-DATE-TIME-MEDIUM | 13-Jun-2017 17:43:33|\n | LOCALIZED-DATE-TIME-LONG | 13 June 2017 17:43:33 CEST|\n | LOCALIZED-DATE-TIME-FULL | Tuesday, 13 June 2017 04:53:33 o'clock CEST|\n | EPOCH-MILLI | 1499347299|\n\n\n "
pattern: String): String!
size(
"size format"
format: BytesUnits = Human): BytesBinary!
data: String!
"Thumbnail data if present, base64 encoded"
thumbnail: String @deprecated(reason: "Will be removed in the future, content always empty")
"Link to file, the file will be shown in browser. Validation is needed in the same way as the graphql API, by a cookie with the token, a request header 'X-Auth-Token' with the token or a request parameter 'token'"
link: String!
"Download link to attachment, the attachment will be downloaded. Validation is needed in the same way as the graphql API, by a cookie with the token, a request header 'X-Auth-Token' with the token or a request parameter 'token'"
downloadLink: String!
"Link to attachment thumbnail (or original if no thumbnail exists). Validation is needed in the same way as the graphql API, by a cookie with the token, a request header 'X-Auth-Token' with the token or a request parameter 'token'"
thumbnailLink: String
}
"New attachment details and content"
input AttachmentCreate {
"Human readable label for the attachment"
displayName: String!
"Filename for attachment"
filename: String!
"attachment content Base64 encoded"
dataBase64: String!
}
scalar AttachmentId
type Billing {
"""
Company subscriptions
Access for users with role : Administrator || Accounting
Required permissions: Accounting: read
"""
subscriptions(ordering: SubscriptionsOrder): SubscriptionsCollection!
"""
Subscription details
Access for users with role : Administrator || Accounting
Required permissions: Accounting: read
"""
subscription(id: SubscriptionId!): SaleSubscription!
}
enum BootDevice {
NoOverride
"Boot from first disk"
Disk
DiskSafe
"Boot inti Diagnostic mode"
Diagnostic
"Use PXE (Preboot Execution Environment) as boot option"
Pxe
"Boot into BIOS"
Bios
Cdrom
}
scalar BytesBinary
scalar BytesDecimal
"the format of the bytes"
enum BytesUnits {
"return in Bytes"
Bytes
"return in best human readable resolution (kb, mb, gb, tb, ..)"
Human
"return in KiloByte"
KiloByte
"return in MegaByte"
MegaByte
"return in GigaByte"
GigaByte
}
"Classless Inter-Domain Routing"
scalar Cidr
"Object identified by parent object ID."
type ClustersCollection {
nodes: [KubernetesCluster!]!
"total count, in case of missing permission to read -1 is returned"
totalCount: Int!
}
"Company details"
type Company {
id: CompanyId!
updated: Timestamp!
"Company name"
name: String!
website: String
"Company address"
address: Address
phone: String
note: String
appraisal: String
useByAsergoMarketingAccepted: Boolean!
"""
Billing area
Access for users with role : Administrator || Accounting
Required permissions: Accounting: read
"""
billing: Billing
"""
Access for users with role : Administrator || Technical || Accounting
Required permissions: Server: read
"""
servers: ServersCollection!
"""
Access for users with role : Administrator
Required permissions: User management: read
"""
invites(ordering: InvitesOrder): InvitesCollection!
"""
Access for users with role : Administrator || Technical || Accounting
Required permissions: Kubernetes management: read
"""
kubernetes: ClustersCollection!
"""
Access for users with role : Administrator
Required permissions: Object storage: Viewer
"""
objectStorage: ObjectStorageCollection!
services(ordering: DashboardServicesOrder): DashboardServicesCollection!
"""
Config file content for your kubectl. Save config file in the kube config directory : ~/.kube/config
Access for users with role : Administrator || Technical || Accounting
Required permissions: Kubernetes management: read
"""
kubectlConfig: String
"""
Public Authoritative name server
Access for users with role : Administrator || Technical
Required permissions: DNS domain: read
"""
domains(ordering: DnsDomainsOrder): DnsDomainsCollection!
"""
Access for users with role : Administrator
Required permissions: OpenID Connect: read
"""
oidc(ordering: OidcClientOrder): OidcClientCollection!
"Company logo url"
logo: String
logoSize(
"size format"
format: BytesUnits = Human): BytesBinary
"""
Legal Owner can see all contacts, other users can only see users with dashboard access
Access for users with role : Administrator || Technical || Accounting
Required permissions: Users: read
"""
users(ordering: UsersOrder): UsersCollection!
}
"CompanyChangeEvent indicates updates for company details"
type CompanyChangeEvent {
company: CompanyId!
type: EventChangeType!
data: Company
}
"Client company ID"
scalar CompanyId
"CompanyUpdateEvent indicates updates related to current company"
type CompanyUpdateEvent {
type: EventChangeType!
company: Company
user: User
userInvite: UserInviteDetails
supportTicket: Ticket
kubernetes: KubernetesCluster
}
"""
Updates for a company.
Only fields supplied are updated
"""
input CompanyUpdateInput {
"Update Company name"
name: String
phone: String
note: String
"Address updates"
address: AddressUpdate
website: String
appraisal: String
useByAsergoMarketingAccepted: Boolean
}
"Company update result"
type CompanyUpdatePayload {
company: Company
error: String
warning: String
success: Boolean!
}
"Complete a invitation."
input CompleteUserInviteInput {
"Invitation token, received by email"
token: String!
"Username"
username: String!
"""
Password
Must be longer than 5 and contain #, !, -, _, $, ?, * or a number
"""
password: String!
}
"Result of user creation"
type CompleteUserInvitePayload {
success: Boolean!
error: String
}
"Contact request content"
input ContactRequestInput {
"Email address we will respond to"
email: String!
"Your Name"
name: String
subject: String!
"Body of your request"
content: String!
"Media your request is submitted from, eg. website/dashboard/app"
origin: String
type: ContactRequestType
}
"result of contact request"
type ContactRequestPayload {
success: Boolean!
information: String
warning: String
error: String
}
"Type of contact request"
enum ContactRequestType {
"Support"
SupportType
"Abuse"
AbuseType
"Sales"
SalesType
}
"""
ISO 3166-1 alpha-3 country code.
Also accepts ISO 3166-1 alpha-2 country codes and country names in English, German, Danish and French
"""
scalar CountryISO
type Cpu implements Part {
architecture: Architecture!
"Part id"
id: ID!
"Parts logical name"
logicalName: String
vendor: String
serialNumber: String
productNumber: String
inventorySlot: String
index: Index
server: Server
firmware: String
partType: String!
}
"Invite an existing contact to the company dashboard with caller as invite. The user will receive an email with the invitation and a link to create a login to the dashboard"
input CreateContactInviteInput {
"User ID to the Contact"
id: UserId!
"Legal Authority rights give access to everything. Accounting, Servers, etc. Only users with Legal Authority can manage users"
legalAuthorityAccess: Boolean!
"User have access to all server, network etc."
technicalAccess: Boolean!
"User have access to invoices and billing information"
accountingAccess: Boolean!
"Message that will be included in the email to the Contact"
message: String!
}
"Create a object storage"
input CreateObjectStorageInput {
company: CompanyId
name: String!
"""
"Control internet access.
If no whitelist is supplied access from anywhere is granted.
If an empty list is supplied, only access from within ASERGO networks
If a access list is supplied access from access list and ASERGO networks"
"""
accessList: [String!]
description: String!
}
"object storage creation result"
type CreateObjectStoragePayload {
data: ObjectStorageBucket
error: String
warning: String
success: Boolean!
}
input CreatePasswordCredential {
"New username"
username: String!
"New password"
password: String!
}
input CreateServiceAccountInput {
name: String!
note: String
passwordCredential: CreatePasswordCredential
}
"Create a invitation to the company dashboard with caller as invite. The user will receive an email with the invitation and a link to create a login to the dashboard"
input CreateUserInviteInput {
"Name on the user to invite"
userName: String!
"Email the invite is sent to"
userEmail: String!
"Legal Authority rights give access to everything. Accounting, Servers, etc. Only users with Legal Authority can manage users"
legalAuthorityAccess: Boolean!
"User have access to all server, network etc."
technicalAccess: Boolean!
"User have access to invoices and billing information"
accountingAccess: Boolean!
"Message that will be included in the email to the Contact"
message: String!
}
interface Credential {
type: String!
}
"Object identified by parent object ID."
type CredentialsCollection {
nodes: [Credential!]!
"total count, in case of missing permission to read -1 is returned"
totalCount: Int!
passwordCount: Int!
oauthCount: Int!
}
"Dashboard area information"
type Dashboard {
"area identifier"
id: String!
parent: String
"Area type"
type: String!
"Dashboard title"
title: String!
"If area is disabled"
active: Boolean!
maintenance: Boolean!
"Area information"
info: String
"Warning for dashboard area"
warningMessage: String
debug: Boolean!
}
"Dashboard loading status and information, including url for remote dashboards"
type DashboardLoadPayload {
success: Boolean!
error: String
"Dashboard info"
info: Dashboard
"Remote dashboard url"
url: String
}
"Dashboard notification"
type DashboardNotification {
"Notification content"
content: String!
timestamp(
"Timezone eg. Europe/Copenhagen, America/Toronto, Etc/GMT+1, +01:00"
timezone: TimeZone,
"\n Time pattern in java format\n see [Patterns for Formatting and Parsing](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html)\n Default pattern is: `yyyy-MM-dd'T'HH:mm:ssZ`\n\n ### Reserved formatting words:\n | Format name | Example |\n |---------|---------|\n | ISO_DATE | 2017-06-20+02:00 |\n | ISO_DATE_TIME | 2017-06-15T22:35:50.247+02:00[Europe/Copenhagen] |\n | ISO_TIME | 22:35:50.247+02:00|\n | ISO_LOCAL_DATE | 2017-06-18|\n | ISO_LOCAL_DATE_TIME | 2011-12-03T10:15:30|\n | BASIC_ISO_DATE | 20170620+0200|\n | RFC_1123_DATE_TIME | Tue, 20 Jun 2017 01:17:50 +0200|\n | LOCALIZED-DATE-TIME-SHORT | 13/06/17 17:43|\n | LOCALIZED-DATE-TIME-MEDIUM | 13-Jun-2017 17:43:33|\n | LOCALIZED-DATE-TIME-LONG | 13 June 2017 17:43:33 CEST|\n | LOCALIZED-DATE-TIME-FULL | Tuesday, 13 June 2017 04:53:33 o'clock CEST|\n | EPOCH-MILLI | 1499347299|\n\n\n "
pattern: String): String!
}
"Describes a service available in customer dashboard, proxy, etc."
type DashboardService {
"unique service identifier"
id: DashboardServiceId!
active: Boolean!
maintenance: Boolean!
type: ServiceVariantType!
"The name of the service"
name: String!
description: String!
cluster: K8sClusterId
}
scalar DashboardServiceId
"Object identified by parent object ID."
type DashboardServicesCollection {
nodes: [DashboardService!]!
"total count, in case of missing permission to read -1 is returned"
totalCount: Int!
orderedBy: DashboardServicesOrder
}
"DashboardServices field to sort collection by"
enum DashboardServicesOrder {
NAME
COMPANY
CLUSTER
}
scalar DeviceId
type Disk implements Part {
diskType: DiskType
bytesDecimal(
"size format"
format: BytesUnits = Human): BytesDecimal!
raidInfo: DiskRaidInfo
"Part id"
id: ID!
"Parts logical name"
logicalName: String
vendor: String
serialNumber: String
productNumber: String
inventorySlot: String
index: Index
server: Server
firmware: String
partType: String!
}
type DiskRaidInfo {
id: InventoryPartId!
deviceId: String!
}
enum DiskType {
Hdd
Ssd
Other
Unknown
}
"Dns domain"
type DnsDomain {
"unique domain identifier"
id: DnsDomainId!
"List of domain records."
records: [DnsRecord!]!
"domain name."
name: String!
"Zone file content for the domain/zone."
zoneFile: String!
}
scalar DnsDomainId
"DNS domain result"
type DnsDomainPayload {
data: DnsDomain
error: String
warning: String
success: Boolean!
}
"Object identified by parent object ID."
type DnsDomainsCollection {
nodes: [DnsDomain!]!
"total count, in case of missing permission to read -1 is returned"
totalCount: Int!
orderedBy: DnsDomainsOrder
}
"DnsDomains field to sort collection by"
enum DnsDomainsOrder {
DOMAIN
}
"Dns record for a single domain"
type DnsRecord {
"unique record identifier"
id: DnsRecordId!
"The host name, service, or alias defined by the record."
name: String!
"DNS record type, supported types: A, AAAA, ALIAS, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT"
type: DnsRecordType!
"""
Variable content depending on record type.
For example:
* For a A record would be the IPv4 address to which the domain will be mapped.
* For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
* For a CNAME, MX, NS, SRV record, it should be a full hostname.
"""
content: String!
"Indicate which of the servers listed as MX records it should attempt to use first."
priority: Int
"Time to live in seconds, default 1800"
ttl: Int
"The port for SRV records."
port: Int
"The weight for SRV records."
weight: Int
"An unsigned integer between 0-255 used for CAA records."
flags: Int
"The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""
tag: String
}
scalar DnsRecordId
"Full dns record details, all fields will be replaced"
input DnsRecordInput {
"unique record identifier"
id: DnsRecordId!
"""
The host name, service, or alias defined by the record.
Required by: A, AAAA, CAA, CNAME, TXT, SRV
"""
name: String!
"""
DNS record type, supported types: A, AAAA, ALIAS, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT
Customers are only allowed to create records of types: A, AAAA, CAA, MX, NS, TXT, CNAME, SRV
"""
type: DnsRecordType!
"""
Variable content depending on record type.
For example:
* For a A record would be the IPv4 address to which the domain will be mapped.
* For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
* For a CNAME, MX, NS, SRV record, it should be a full hostname.
* For a TXT record, it should be a text string not wrapped in quotes.
"""
content: String!
"""
Indicate which of the servers listed as MX records it should attempt to use first.
Required by: MX, SRV
"""
priority: Int
"Time to live in seconds, default 1800"
ttl: Int
"""
The port for SRV records.
Required by: SRV
"""
port: Int
"""
The weight for SRV records.
Required by: SRV
"""
weight: Int
"""
An unsigned integer between 0-255 used for CAA records.
Required by: CAA
"""
flags: Int
"""
The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef"
Required by: CAA
"""
tag: String
}
"DNS record type"
enum DnsRecordType {
A
AAAA
ALIAS
CAA
CNAME
MX
NS
PTR
SOA
SRV
TXT
}
scalar DnsServerId
"Dns domain updates"
type DnsUpdateEvent {
id: DnsDomainId!
type: EventChangeType!
domain: DnsDomain
}
"Create a new domain for"
input DomainCreateInput {
"DNS server id, for customer dns \"ns1.asergo.com\" should be used and is default value"
server: DnsServerId
"Domain name to create all in lowercase, [a-z0-9][a-z0-9\\.-]{1,61}[a-z0-9]\\.[a-z]{2,}"
domain: String!
"Initial DNS records for the record"
records: [DomainRecordCreate!]!
}
"Data for new record to create"
input DomainRecordCreate {
"""
The host name, service, or alias defined by the record.
Required by: A, AAAA, CAA, CNAME, TXT, SRV
"""
name: String!
"DNS record type, supported types: A, AAAA, ALIAS, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT"
type: DnsRecordType!
"""
Variable content depending on record type.
For example:
* For a A record would be the IPv4 address to which the domain will be mapped.
* For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
* For a CNAME, MX, NS, SRV record, it should be a full hostname.
* For a TXT record, it should be a text string not wrapped in quotes.
"""
content: String!
"""
Indicate which of the servers listed as MX records it should attempt to use first.
Required by: MX, SRV
"""
priority: Int
"Time to live in seconds, default 1800"
ttl: Int
"""
The port for SRV records.
Required by: SRV
"""
port: