| Types | |
| Types | |
| APIKey | Structure representing an API key |
| APIKeyACL | Structure of an API key’s ACL entry |
| APIKeyACLId | Base type Thrift.i32 |
| APIKeyId | Base type Thrift.i32 |
| APIKeyType | |
| APIKeys | Base type Thrift.list (Types.APIKey) |
| CACityLocality | Base type Thrift.string |
| CACommonName | Base type Thrift.string |
| CACountry | Base type Thrift.string |
| CADays | Base type Thrift.i16 |
| CAHash | Base type Thrift.string |
| CAOrganization | Base type Thrift.string |
| CAOrganizationUnit | Base type Thrift.string |
| CAStateProvince | Base type Thrift.string |
| CIDRMask | Base type Thrift.i16 |
| CRUDObjectSettingAction | |
| CRUDObjectSettingChange | Argument for Common.batchSettingChanges |
| CRUDObjectSettingResponse | Response from Common.batchSettingChanges |
| CSR | Representation of a Certificate Signing Request If the list ‘verifies’ has data, the CSR cannot yet be used for creating a certificate. |
| CSRId | Base type Thrift.i32 |
| CSRMeta | A CSR with the private optionally included |
| CSRVerification | Data necessary to verify a CSR |
| CSRVerificationType | |
| Certificate | Representation of an SSL certificate If ‘verify’.’ |
| CertificateId | Base type Thrift.i32 |
| CertificateMeta | A Certificate with optionally the CSR and private key |
| CertificateVerification | Indication of verified Certificate |
| ComputedObjectSettings | A list of computed object settings with the related catalog |
| Contact | Customer contact and related data |
| ContactId | Base type Thrift.i32 |
| ContactMethod | A contact method type |
| ContactMethodId | Base type Thrift.i32 |
| ContactNoticeType | Contact stuff /// A contact notice type |
| ContactNoticeTypeId | Base type Thrift.i32 |
| ContainerBackup | Representation of PVA backup object |
| ContainerBackupId | Base type Thrift.string |
| ContainerBackupType | |
| ContainerCommand | A command one can call against a container |
| ContainerCommandArgument | Struct of both the spec and passed value of arguments |
| ContainerCommandId | Base type Thrift.i16 |
| ContainerCommandResponse | The result of a command called against a container |
| ContainerDetails | Returned from some Container.* calls |
| ContainerDiskSpace | Base type Thrift.i16 |
| ContainerEnvironmentDetails | Container configuration for a specific environment |
| ContainerHistoricalAlert | A past Container alert |
| ContainerHistoricalAlertCounter | |
| ContainerHistoricalAlertType | |
| ContainerHistoricalStatus | A past Container status |
| ContainerHistoricalStatusName | |
| ContainerHistoricalTransitionName | |
| ContainerId | Base type Thrift.i32 |
| ContainerName | Base type Thrift.string |
| ContainerOOMEvent | An event indicating a moment when memory was running out on a container and an effort was made to kill a process using too much memory. |
| ContainerSize | |
| ContainerStatus | |
| ContainerType | Struct to define the type of a container or site environment stack |
| ContainerTypeId | Base type Thrift.i16 |
| ContainerUuid | Base type Thrift.string |
| CustomerContactId | Base type Thrift.i32 |
| CustomerContactMethod | Sub-struct of Contact |
| CustomerContactMethodId | Base type Thrift.i32 |
| CustomerContactMethodNotice | Sub-struct of CustomerContactMethod |
| CustomerContactMethodNoticeId | Base type Thrift.i32 |
| CustomerId | Base type Thrift.i16 |
| CustomerName | Base type Thrift.string |
| CustomerNotice | A customer notice of an time-sensitive issue |
| CustomerNoticeId | Base type Thrift.i32 |
| CustomerUsername | Base type Thrift.string |
| DNSCheck | Structure encapsulating a DNS check |
| DatabaseBackup | Record for a database backup. |
| DatabaseBackupId | Base type Thrift.string |
| DatabaseCreateResult | The result of a Database.create or .clone call |
| DatabaseDetails | Details for a shared database |
| DatabaseId | Base type Thrift.i16 |
| DatabaseName | Base type Thrift.string |
| DatabasePassword | Base type Thrift.string |
| DatabaseSizeHistory | Wrapper for db rows from CustomerDatabaseSizeHistory |
| DatabaseSlowLog | Wrapper for db rows from CustomerDatabaseUserSlowLog |
| DatabaseType | |
| DatabaseUser | Base type Thrift.string |
| DatabaseUserDetails | Details for a shared database user |
| DatabaseUserId | Base type Thrift.i32 |
| DatabaseUserType | |
| DistinguishedName | Representation of the subject of a CSR and Certificate |
| DomainDetails | A representation of a domain |
| DomainId | Base type Thrift.i32 |
| DomainName | Base type Thrift.string |
| DomainRecordContent | Base type Thrift.string |
| DomainRecordDetails | A representation of a domain record |
| DomainRecordId | Base type Thrift.i32 |
| DomainRecordName | Base type Thrift.string |
| DomainRecordPriority | Base type Thrift.i16 |
| DomainRecordTTL | Base type Thrift.i32 |
| DomainRecordType | |
| EmailAddress | Base type Thrift.string |
| EnvironmentAlias | Base type Thrift.string |
| EnvironmentAliasId | Base type Thrift.i16 |
| EnvironmentAliasList | Base type Thrift.map (Types.EnvironmentAliasId => Types.EnvironmentAlias) |
| EnvironmentDetails | Details for an Environment |
| EnvironmentDocumentRoot | Base type Thrift.string |
| EnvironmentId | Base type Thrift.i16 |
| EnvironmentName | Base type Thrift.string |
| FTPUser | A single Customer-controlled FTP user |
| FTPUserId | Base type Thrift.i32 |
| FTPUserType | |
| Hostname | Base type Thrift.string |
| IPAddress | Base type Thrift.string |
| IPAddressDetails | Generic, typed struct for all Customer-referenced address details |
| IPAddressDetailsEnvironment | Optional sub-struct of IPAddressDetails |
| IPAddressDetailsSite | Optional sub-struct of IPAddressDetails |
| IPAddressDetailsType | |
| LiveEnvironmentHistory | Base type Thrift.map (Types.EnvironmentId => Types.TimeInterval) |
| LoadBalancerStatus | A representation of most all the data found in haproxy stats |
| OS | OS db object |
| OSId | Base type Thrift.i16 |
| ObjectId | Base type Thrift.i32 |
| ObjectSetting | An objects setting |
| ObjectSettingContext | |
| ObjectSettingId | Base type Thrift.i32 |
| PBA_paymentMethodId | Base type Thrift.i32 |
| PEMString | Base type Thrift.string |
| PingResponse | Response to Common.ping |
| Process | A single process, sampled at a moment in time, running on a container |
| ProcessTable | A sample of all the processes running on a container at a moment in time |
| ProcessTableGraph | A graph of process data over a period of time See Container.getProcessTableGraph |
| ProcessTableGraphProcess | A single process and a list of graph data for metric(s) No context for this data. |
| ProcessTableMetric | |
| ResourceCurrentUsage | Current resource usage for a container. |
| ResourceHistoricalUsage | Moment in time resource usage for a container. |
| ResourceUsage | An all-optional representation of the value of a single resource |
| ResourceUsageType | |
| ResourceUsageUnit | |
| Role | Base type Thrift.string |
| Roles | Base type Thrift.list (Types.Role) |
| SecretKey | Base type Thrift.string |
| SettingCatalog | A setting catalog item |
| SettingClass | Base type Thrift.string |
| SettingId | Base type Thrift.i32 |
| SettingKey | Base type Thrift.string |
| SettingList | Base type Thrift.map (Types.SettingKey => Types.SettingValue) |
| SettingName | Base type Thrift.string |
| SettingSelectKey | Base type Thrift.string |
| SettingSelectOption | Select option pair for the setting catalog |
| SettingType | |
| SettingValue | Base type Thrift.string |
| SiteAlias | Base type Thrift.string |
| SiteAliasId | Base type Thrift.i16 |
| SiteAliasList | Base type Thrift.map (Types.SiteAliasId => Types.SiteAlias) |
| SiteDetails | Site Details |
| SiteId | Base type Thrift.i16 |
| SiteLoadBalancerStatus | All the LoadBalancerStatus records that are associated with the live site |
| SiteName | Base type Thrift.string |
| SiteStatus | |
| SubjectAltName | An alternative name for a certificate Provide either ‘dns’ or ‘ip’ but not both. |
| TimeInterval | Structure which defines an interval |
| URL | Base type Thrift.string |
| UnixTime | Base type Thrift.i32 |
| Exceptions | |
| Types | |
| BillingFailed | The billing failed |
| InvalidArguments |
Structure representing an API key
| id | no docs (idx: 1, type: Types.APIKeyId) |
| key | no docs (idx: 2, type: Types.SecretKey) |
| customerId | no docs (idx: 3, type: Types.CustomerId) |
| roles | no docs (idx: 4, type: Types.Roles) |
| acls | no docs (idx: 5, type: Thrift.list (Types.APIKeyACL)) |
| type | no docs (idx: 6, type: Types.APIKeyType) |
Structure of an API key’s ACL entry
| id | no docs (idx: 1, type: Types.APIKeyACLId) |
| keyId | no docs (idx: 2, type: Types.APIKeyId) |
| address | no docs (idx: 3, type: Types.IPAddress) |
| cidr | no docs (idx: 4, type: Types.CIDRMask) |
Base type Thrift.i32
Base type Thrift.i32
Base type Thrift.list (Types.APIKey)
Base type Thrift.string
Base type Thrift.string
Base type Thrift.string
Base type Thrift.i16
Base type Thrift.string
Base type Thrift.string
Base type Thrift.string
Base type Thrift.string
Base type Thrift.i16
Argument for Common.batchSettingChanges
| action | no docs (idx: 1, type: Types.CRUDObjectSettingAction) |
| context | Create (idx: 2, type: Types.ObjectSettingContext, optional: 1) |
| objectId | no docs (idx: 3, type: Types.ObjectId, optional: 1) |
| settingId | no docs (idx: 4, type: Types.SettingId, optional: 1) |
| value | Create, Update (idx: 5, type: Types.SettingValue, optional: 1) |
| id | Update, Delete (idx: 6, type: Types.ObjectSettingId, optional: 1) |
Response from Common.batchSettingChanges
| isSuccess | no docs (idx: 1, type: Thrift.bool) |
| id | Create (idx: 2, type: Types.ObjectSettingId, optional: 1) |
| error | no docs (idx: 3, type: Thrift.string, optional: 1) |
Representation of a Certificate Signing Request If the list ‘verifies’ has data, the CSR cannot yet be used for creating a certificate. You must fulfill the verification mechanism for it to be verified. The subject common name and all DNS alt names must be verified.
| id | no docs (idx: 1, type: Types.CSRId) |
| customerId | no docs (idx: 2, type: Types.CustomerId) |
| request | no docs (idx: 3, type: Types.PEMString) |
| subject | no docs (idx: 4, type: Types.DistinguishedName) |
| altNames | no docs (idx: 5, type: Thrift.list (Types.SubjectAltName)) |
| verifies | no docs (idx: 6, type: Thrift.list (Types.CSRVerification), optional: 1) |
Base type Thrift.i32
A CSR with the private optionally included
| csr | no docs (idx: 1, type: Types.CSR) |
| privateKey | no docs (idx: 2, type: Types.PEMString, optional: 1) |
Data necessary to verify a CSR
| id | no docs (idx: 1, type: Types.CSRId) |
| type | no docs (idx: 2, type: Types.CSRVerificationType) |
| data | no docs (idx: 3, type: Thrift.map (Thrift.string => Thrift.string)) |
Representation of an SSL certificate If ‘verify’.’isValid’ is not true, the certificate cannot be installed onto a Site. See ‘verify’.’message’ for the reason why it’s not valid.
| id | no docs (idx: 1, type: Types.CertificateId) |
| customerId | no docs (idx: 2, type: Types.CustomerId, optional) |
| certificate | no docs (idx: 3, type: Types.PEMString) |
| validFrom | no docs (idx: 4, type: Types.UnixTime) |
| validTo | no docs (idx: 5, type: Types.UnixTime) |
| subject | no docs (idx: 6, type: Types.DistinguishedName) |
| issuer | no docs (idx: 7, type: Types.DistinguishedName) |
| altNames | no docs (idx: 8, type: Thrift.list (Types.SubjectAltName)) |
| verify | no docs (idx: 9, type: Types.CertificateVerification) |
| associatedSite | no docs (idx: 10, type: Types.SiteDetails, optional: 1) |
Base type Thrift.i32
A Certificate with optionally the CSR and private key
| certificate | no docs (idx: 1, type: Types.Certificate) |
| csr | no docs (idx: 2, type: Types.CSR, optional: 1) |
| privateKey | no docs (idx: 3, type: Types.PEMString, optional: 1) |
| chain | no docs (idx: 4, type: Thrift.list (Types.Certificate), optional: 1) |
Indication of verified Certificate
| isValid | no docs (idx: 1, type: Thrift.bool) |
| message | no docs (idx: 2, type: Thrift.string) |
| siteReady | Indicates if the Certificate can be installed via Site.assignCertificate (idx: 3, type: Thrift.bool) |
A list of computed object settings with the related catalog
| context | no docs (idx: 1, type: Types.ObjectSettingContext) |
| objectId | no docs (idx: 2, type: Types.ObjectId) |
| catalog | no docs (idx: 3, type: Thrift.list (Types.SettingId)) |
| settings | no docs (idx: 4, type: Thrift.list (Types.ObjectSetting)) |
Customer contact and related data
| id | no docs (idx: 1, type: Types.ContactId) |
| customerId | no docs (idx: 2, type: Types.CustomerId) |
| name | no docs (idx: 3, type: Thrift.string) |
| methods | no docs (idx: 4, type: Thrift.list (Types.CustomerContactMethod)) |
Base type Thrift.i32
A contact method type
| id | no docs (idx: 1, type: Types.ContactMethodId) |
| name | no docs (idx: 2, type: Thrift.string) |
| description | no docs (idx: 3, type: Thrift.string) |
| spec | no docs (idx: 4, type: Thrift.map (Thrift.string => Thrift.string), optional: 1) |
Base type Thrift.i32
Contact stuff /// A contact notice type
| id | no docs (idx: 1, type: Types.ContactNoticeTypeId) |
| name | no docs (idx: 2, type: Thrift.string) |
| description | no docs (idx: 3, type: Thrift.string) |
| spec | no docs (idx: 4, type: Thrift.map (Thrift.string => Thrift.string), optional: 1) |
Base type Thrift.i32
Representation of PVA backup object
| id | no docs (idx: 1, type: Types.ContainerBackupId) |
| timestamp | no docs (idx: 2, type: Types.UnixTime) |
| bytes | no docs (idx: 3, type: Thrift.i64) |
| description | no docs (idx: 4, type: Thrift.string, optional: 1) |
| type | no docs (idx: 5, type: Types.ContainerBackupType) |
Base type Thrift.string
A command one can call against a container
| id | no docs (idx: 1, type: Types.ContainerCommandId) |
| name | no docs (idx: 2, type: Thrift.string) |
| arguments | no docs (idx: 3, type: Thrift.list (Types.ContainerCommandArgument)) |
Struct of both the spec and passed value of arguments
| value | no docs (idx: 1, type: Thrift.string, optional: 1) |
| description | no docs (idx: 2, type: Thrift.string, optional: 1) |
| options | no docs (idx: 3, type: Thrift.list (Thrift.string), optional: 1) |
| isRequired | no docs (idx: 4, type: Thrift.bool, optional: 1) |
| isFreeform | no docs (idx: 5, type: Thrift.bool, optional: 1) |
| defaultValue | no docs (idx: 6, type: Thrift.string, optional: 1) |
Base type Thrift.i16
The result of a command called against a container
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| containerCommandId | no docs (idx: 2, type: Types.ContainerCommandId) |
| arguments | no docs (idx: 3, type: Thrift.list (Types.ContainerCommandArgument)) |
| status | no docs (idx: 4, type: Thrift.i16) |
| stderr | no docs (idx: 5, type: Thrift.string) |
| stdout | no docs (idx: 6, type: Thrift.string) |
Returned from some Container.* calls
| customerId | Id of the owning Customer (idx: 1, type: Types.CustomerId) |
| id | Unique ID for the container (idx: 2, type: Types.ContainerId) |
| uuid | Universally unique ID for the container (idx: 3, type: Types.ContainerUuid) |
| address | Public ip address for the container (idx: 4, type: Types.IPAddress) |
| name | Container name (idx: 5, type: Types.ContainerName) |
| osId | no docs (idx: 16, type: Types.OSId) |
| type | no docs (idx: 15, type: Types.ContainerTypeId) |
| hostname | Hostname for the container (xxx.digest.stackablehost.com) (idx: 8, type: Types.Hostname) |
| environments | List of Environments this container serves. (idx: 9, type: Thrift.list (Types.EnvironmentId)) |
| size | no docs (idx: 10, type: Types.ContainerSize) |
| diskSpace | no docs (idx: 17, type: Types.ContainerDiskSpace) |
| status | no docs (idx: 11, type: Types.ContainerStatus) |
| statusCurrent | no docs (idx: 12, type: Types.ContainerStatus) |
| statusRecent | no docs (idx: 13, type: Types.ContainerStatus) |
| latestResourceUsage | no docs (idx: 14, type: Types.ResourceCurrentUsage, optional: 1) |
| addresses | no docs (idx: 18, type: Thrift.list (Types.IPAddress), optional: 1) |
Base type Thrift.i16
Container configuration for a specific environment
| id | no docs (idx: 1, type: Types.ContainerId) |
| uuid | no docs (idx: 3, type: Types.ContainerUuid) |
| name | no docs (idx: 4, type: Types.ContainerName) |
| address | no docs (idx: 5, type: Types.IPAddress) |
| hostname | Speical hostname for this ContainerSiteEnvironment (idx: 6, type: Types.Hostname) |
| docroot | no docs (idx: 7, type: Types.EnvironmentDocumentRoot) |
| isMaster | no docs (idx: 8, type: Thrift.bool) |
| environmentId | no docs (idx: 9, type: Types.EnvironmentId) |
| environmentName | no docs (idx: 10, type: Types.EnvironmentName) |
| siteHostname | no docs (idx: 11, type: Types.Hostname) |
| isLive | no docs (idx: 12, type: Thrift.bool) |
| type | no docs (idx: 13, type: Types.ContainerTypeId) |
| siteId | no docs (idx: 14, type: Types.SiteId) |
A past Container alert
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| counter | no docs (idx: 3, type: Types.ContainerHistoricalAlertCounter) |
| soft | no docs (idx: 4, type: Thrift.i32) |
| hard | no docs (idx: 5, type: Thrift.i32) |
| current | no docs (idx: 6, type: Thrift.i32) |
| type | no docs (idx: 7, type: Types.ContainerHistoricalAlertType) |
A past Container status
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| statusNew | no docs (idx: 3, type: Types.ContainerHistoricalStatusName) |
| transitionNew | no docs (idx: 4, type: Types.ContainerHistoricalTransitionName) |
| statusOld | no docs (idx: 5, type: Types.ContainerHistoricalStatusName) |
| transitionOld | no docs (idx: 6, type: Types.ContainerHistoricalTransitionName) |
Base type Thrift.i32
Base type Thrift.string
An event indicating a moment when memory was running out on a container and an effort was made to kill a process using too much memory. If not isKilled, indicates only that a signal was sent. Due to a flaw in the reporting system, there’s no guarantee that a signal will be followed by an isKilled event, and vice versa. True success is not indicated.
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| npid | Node process id; can be correlated using a Process (from ProcessTableGraph or ProcessTable) to the container process id (idx: 3, type: Thrift.i32) |
| process | no docs (idx: 4, type: Thrift.string) |
| isKilled | no docs (idx: 5, type: Thrift.bool, optional: 1) |
Struct to define the type of a container or site environment stack
| id | no docs (idx: 1, type: Types.ContainerTypeId) |
| name | no docs (idx: 2, type: Thrift.string) |
| version | no docs (idx: 3, type: Thrift.string) |
| isSiteHost | no docs (idx: 4, type: Thrift.bool) |
| isDatabase | no docs (idx: 5, type: Thrift.bool) |
| isInternal | no docs (idx: 6, type: Thrift.bool) |
| isAvailable | no docs (idx: 7, type: Thrift.bool) |
| isAlpha | no docs (idx: 9, type: Thrift.bool) |
| isBeta | no docs (idx: 8, type: Thrift.bool) |
Base type Thrift.i16
Base type Thrift.string
Base type Thrift.i32
Sub-struct of Contact
| id | no docs (idx: 1, type: Types.CustomerContactMethodId) |
| contactId | no docs (idx: 2, type: Types.ContactId) |
| methodId | no docs (idx: 3, type: Types.ContactMethodId) |
| options | no docs (idx: 4, type: Thrift.map (Thrift.string => Thrift.string), optional: 1) |
| noticeTypes | no docs (idx: 5, type: Thrift.list (Types.CustomerContactMethodNotice)) |
Base type Thrift.i32
Sub-struct of CustomerContactMethod
| id | no docs (idx: 1, type: Types.CustomerContactMethodNoticeId) |
| contactMethodId | no docs (idx: 2, type: Types.CustomerContactMethodId) |
| noticeTypeId | no docs (idx: 3, type: Types.ContactNoticeTypeId) |
| options | no docs (idx: 4, type: Thrift.map (Thrift.string => Thrift.string), optional: 1) |
Base type Thrift.i32
Base type Thrift.i16
Base type Thrift.string
A customer notice of an time-sensitive issue
| id | no docs (idx: 1, type: Types.CustomerNoticeId) |
| message | no docs (idx: 2, type: Thrift.string) |
| created | no docs (idx: 3, type: Types.UnixTime) |
| updated | no docs (idx: 4, type: Types.UnixTime, optional: 1) |
| acknowledged | no docs (idx: 5, type: Types.UnixTime, optional: 1) |
| startTime | no docs (idx: 6, type: Types.UnixTime) |
| endTime | no docs (idx: 7, type: Types.UnixTime, optional: 1) |
| isActive | no docs (idx: 8, type: Thrift.bool) |
| isGlobal | no docs (idx: 9, type: Thrift.bool) |
| noticeTypeId | no docs (idx: 10, type: Types.ContactNoticeTypeId, optional: 1) |
| timeContactsNotified | no docs (idx: 11, type: Thrift.map (Types.CustomerContactMethodId => Types.UnixTime), optional: 1) |
| noticeTypeOptions | no docs (idx: 12, type: Thrift.map (Thrift.string => Thrift.string), optional: 1) |
| containerId | no docs (idx: 13, type: Types.ContainerId, optional: 1) |
| siteId | no docs (idx: 14, type: Types.SiteId, optional: 1) |
Base type Thrift.i32
Base type Thrift.string
Structure encapsulating a DNS check
| successful | no docs (idx: 1, type: Thrift.bool) |
| error | no docs (idx: 2, type: Thrift.string) |
| unknown | no docs (idx: 3, type: Thrift.bool) |
| address | no docs (idx: 4, type: Types.IPAddress, optional: 1) |
| hostname | no docs (idx: 5, type: Types.Hostname, optional: 1) |
| type | no docs (idx: 6, type: Thrift.string, optional: 1) |
Record for a database backup.
| id | no docs (idx: 1, type: Types.DatabaseBackupId) |
| database | no docs (idx: 2, type: Types.DatabaseName) |
| backupURL | no docs (idx: 3, type: Types.URL) |
| size | no docs (idx: 5, type: Thrift.i32) |
| timestamp | no docs (idx: 6, type: Types.UnixTime) |
Base type Thrift.string
The result of a Database.create or .clone call
| database | no docs (idx: 1, type: Types.DatabaseDetails) |
| user | no docs (idx: 2, type: Types.DatabaseUserDetails) |
Details for a shared database
| id | no docs (idx: 1, type: Types.DatabaseId) |
| name | no docs (idx: 2, type: Types.DatabaseName) |
| friendlyName | no docs (idx: 3, type: Types.DatabaseName) |
| type | no docs (idx: 4, type: Types.DatabaseType) |
| host | no docs (idx: 5, type: Types.Hostname) |
| replicas | no docs (idx: 6, type: Thrift.list (Types.Hostname)) |
Base type Thrift.i16
Base type Thrift.string
Base type Thrift.string
Wrapper for db rows from CustomerDatabaseSizeHistory
| databaseId | no docs (idx: 1, type: Types.DatabaseId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| totalMb | no docs (idx: 3, type: Thrift.i32) |
| dataMb | no docs (idx: 4, type: Thrift.i32) |
| indexMb | no docs (idx: 5, type: Thrift.i32) |
| tableCount | no docs (idx: 6, type: Thrift.i32) |
Wrapper for db rows from CustomerDatabaseUserSlowLog
| databaseId | no docs (idx: 1, type: Types.DatabaseId) |
| userId | no docs (idx: 2, type: Types.DatabaseUserId) |
| time | no docs (idx: 3, type: Types.UnixTime) |
| rowsRead | no docs (idx: 4, type: Thrift.i32) |
| rowsAffected | no docs (idx: 5, type: Thrift.i32) |
| rowsExamined | no docs (idx: 6, type: Thrift.i32) |
| rowsSent | no docs (idx: 7, type: Thrift.i32) |
| queryTime | no docs (idx: 8, type: Thrift.i32) |
| lockTime | no docs (idx: 9, type: Thrift.i32) |
| queryPartial | no docs (idx: 10, type: Thrift.string) |
| queryLength | no docs (idx: 11, type: Thrift.i32) |
Base type Thrift.string
Details for a shared database user
| databaseId | no docs (idx: 1, type: Types.DatabaseId) |
| id | no docs (idx: 2, type: Types.DatabaseUserId) |
| username | no docs (idx: 3, type: Types.DatabaseUser) |
| password | If storePassword wasn’t true when the user was created or updateUser was called, this will be unset (idx: 4, type: Types.DatabasePassword, optional: 1) |
| userType | no docs (idx: 5, type: Types.DatabaseUserType) |
| hostsAllow | If empty, all hosts are permitted. Otherwise, only those listed. (idx: 6, type: Thrift.list (Types.Hostname)) |
| pgDatabaseOwner | For PostgreSQL databases, one user is the designated owner of the database (idx: 7, type: Thrift.bool, optional: 1) |
Base type Thrift.i32
Representation of the subject of a CSR and Certificate
| country | no docs (idx: 1, type: Types.CACountry) |
| state | no docs (idx: 2, type: Types.CAStateProvince) |
| city | no docs (idx: 3, type: Types.CACityLocality) |
| organization | no docs (idx: 4, type: Types.CAOrganization) |
| unit | no docs (idx: 5, type: Types.CAOrganizationUnit, optional: 1) |
| commonName | no docs (idx: 6, type: Types.CACommonName) |
| no docs (idx: 7, type: Types.EmailAddress) | |
| hash | Will be auto-computed; you don’t need to provide it (idx: 8, type: Types.CAHash, optional: 1) |
A representation of a domain
| id | no docs (idx: 1, type: Types.DomainId) |
| customerId | no docs (idx: 2, type: Types.CustomerId, optional: 1) |
| name | no docs (idx: 3, type: Types.DomainName) |
| dnsCheck | no docs (idx: 4, type: Types.DNSCheck, optional: 1) |
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.string
A representation of a domain record
| id | no docs (idx: 1, type: Types.DomainRecordId) |
| domainId | no docs (idx: 2, type: Types.DomainId) |
| name | no docs (idx: 3, type: Types.DomainRecordName) |
| type | no docs (idx: 4, type: Types.DomainRecordType) |
| content | no docs (idx: 5, type: Types.DomainRecordContent) |
| ttl | no docs (idx: 6, type: Types.DomainRecordTTL, optional: 1) |
| priority | no docs (idx: 7, type: Types.DomainRecordPriority, optional: 1) |
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.i16
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.string
Base type Thrift.i16
Base type Thrift.map (Types.EnvironmentAliasId => Types.EnvironmentAlias)
Details for an Environment
| id | Environment ID (idx: 1, type: Types.EnvironmentId) |
| name | Environment name (idx: 2, type: Types.EnvironmentName) |
| port | Unique port number for the Environment (idx: 3, type: Thrift.i16) |
| luid | Customer-unique id for the Environment (idx: 4, type: Thrift.i16) |
| hostname | Environment-specific hostname (idx: 6, type: Types.Hostname) |
| docroot | no docs (idx: 7, type: Types.EnvironmentDocumentRoot) |
| settings | List of settings for the Environment (idx: 8, type: Types.SettingList) |
| aliases | List of Environment aliases (hostnames) (idx: 9, type: Types.EnvironmentAliasList) |
| containers | List of ContainerIds configured for this Environment; FIXME: doesn’t map to old data structure (lacking) (idx: 10, type: Thrift.list (Types.ContainerEnvironmentDetails)) |
| isLive | no docs (idx: 11, type: Thrift.bool) |
| type | no docs (idx: 12, type: Types.ContainerTypeId) |
Base type Thrift.string
Base type Thrift.i16
Base type Thrift.string
A single Customer-controlled FTP user
| id | no docs (idx: 1, type: Types.FTPUserId) |
| customerId | no docs (idx: 2, type: Types.CustomerId) |
| name | no docs (idx: 3, type: Types.CustomerName) |
| username | no docs (idx: 4, type: Types.CustomerUsername) |
| relativeRoot | no docs (idx: 5, type: Thrift.string, utf8) |
| type | no docs (idx: 6, type: Types.FTPUserType) |
| siteId | no docs (idx: 7, type: Types.SiteId, optional: 1) |
| environmentId | no docs (idx: 8, type: Types.EnvironmentId, optional: 1) |
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.string
Generic, typed struct for all Customer-referenced address details
| type | no docs (idx: 1, type: Types.IPAddressDetailsType) |
| address | no docs (idx: 2, type: Types.IPAddress) |
| isSSLReserved | used only for type ‘Site’ (idx: 3, type: Thrift.bool, optional: 1) |
| hostname | used only for type ‘Container’ (idx: 4, type: Types.Hostname, optional: 1) |
| sites | used only for type ‘Site’ (idx: 5, type: Thrift.list (Types.IPAddressDetailsSite)) |
| environments | used only for type ‘Environment’ (idx: 6, type: Thrift.list (Types.IPAddressDetailsEnvironment)) |
Optional sub-struct of IPAddressDetails
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| name | no docs (idx: 2, type: Types.EnvironmentName) |
| stackableHostname | no docs (idx: 3, type: Types.Hostname) |
| aliases | no docs (idx: 4, type: Thrift.map (Types.EnvironmentAlias => Types.DNSCheck)) |
Optional sub-struct of IPAddressDetails
| id | no docs (idx: 1, type: Types.SiteId) |
| name | no docs (idx: 2, type: Types.SiteName) |
| hostname | no docs (idx: 3, type: Types.Hostname) |
| dnsCheck | no docs (idx: 4, type: Types.DNSCheck) |
| stackableHostname | no docs (idx: 5, type: Types.Hostname) |
| isSSLReserved | no docs (idx: 6, type: Thrift.bool) |
| aliases | no docs (idx: 7, type: Thrift.map (Types.SiteAlias => Types.DNSCheck)) |
Base type Thrift.map (Types.EnvironmentId => Types.TimeInterval)
A representation of most all the data found in haproxy stats
| time | no docs (idx: 1, type: Types.UnixTime) |
| siteId | no docs (idx: 2, type: Types.SiteId) |
| environmentId | no docs (idx: 3, type: Types.EnvironmentId, optional: 1) |
| containerId | no docs (idx: 4, type: Types.ContainerId, optional: 1) |
| bytesIn | no docs (idx: 5, type: Thrift.i64) |
| bytesOut | no docs (idx: 6, type: Thrift.i64) |
| connectionErrors | no docs (idx: 7, type: Thrift.i16, optional: 1) |
| requestErrors | no docs (idx: 8, type: Thrift.i16, optional: 1) |
| deniedRequests | no docs (idx: 9, type: Thrift.i16, optional: 1) |
| deniedResponses | no docs (idx: 10, type: Thrift.i16, optional: 1) |
| redispatchesWarning | no docs (idx: 11, type: Thrift.i16, optional: 1) |
| retriesWarning | no docs (idx: 12, type: Thrift.i16, optional: 1) |
| currentSessions | no docs (idx: 13, type: Thrift.i16) |
| maxSessions | no docs (idx: 14, type: Thrift.i16) |
| totalSessions | no docs (idx: 15, type: Thrift.i32) |
| sessionsLimit | no docs (idx: 16, type: Thrift.i16) |
| maxQueue | no docs (idx: 17, type: Thrift.i16) |
| currentQueue | no docs (idx: 18, type: Thrift.i16) |
| serverIsUp | no docs (idx: 19, type: Thrift.bool) |
| serverDowntime | no docs (idx: 20, type: Thrift.i32, optional: 1) |
| serverUpDownTransitions | no docs (idx: 21, type: Thrift.i16, optional: 1) |
| serverFailedChecks | no docs (idx: 22, type: Thrift.i16, optional: 1) |
| serversInBackend | no docs (idx: 23, type: Thrift.i16, optional: 1) |
| serversUpInBackend | no docs (idx: 24, type: Thrift.i16, optional: 1) |
OS db object
| id | no docs (idx: 1, type: Types.OSId) |
| name | no docs (idx: 2, type: Thrift.string) |
| version | no docs (idx: 3, type: Thrift.string) |
| architecture | no docs (idx: 4, type: Thrift.string) |
| comment | no docs (idx: 5, type: Thrift.string) |
| isInternal | no docs (idx: 6, type: Thrift.bool) |
| isAvailable | no docs (idx: 7, type: Thrift.bool) |
| isAlpha | no docs (idx: 8, type: Thrift.bool) |
| isBeta | no docs (idx: 9, type: Thrift.bool) |
| isUnmanaged | no docs (idx: 10, type: Thrift.bool) |
Base type Thrift.i16
Base type Thrift.i32
An objects setting
| id | no docs (idx: 1, type: Types.ObjectSettingId) |
| context | no docs (idx: 2, type: Types.ObjectSettingContext) |
| objectId | no docs (idx: 3, type: Types.ObjectId) |
| objectName | no docs (idx: 4, type: Thrift.string, optional: 1, utf8) |
| settingId | no docs (idx: 5, type: Types.SettingId) |
| value | no docs (idx: 6, type: Types.SettingValue, optional: 1) |
| defaultValue | no docs (idx: 7, type: Types.SettingValue, optional: 1) |
Base type Thrift.i32
Base type Thrift.i32
Base type Thrift.string
Response to Common.ping
| start | Time (idx: 1, type: Types.UnixTime) |
| pong | Ping response. (idx: 2, type: Thrift.string) |
| echo | Simple payload, if passed. (idx: 3, type: Thrift.string, utf8) |
A single process, sampled at a moment in time, running on a container
| cmd | no docs (idx: 1, type: Thrift.string) |
| comm | no docs (idx: 2, type: Thrift.string) |
| pid | no docs (idx: 3, type: Thrift.i32) |
| ppid | Parent pid; init doesn’t have a parent (idx: 4, type: Thrift.i32, optional: 1) |
| npid | Node pid (idx: 5, type: Thrift.i32, optional: 1) |
| uid | no docs (idx: 6, type: Thrift.i32) |
| gid | no docs (idx: 7, type: Thrift.i32) |
| startTime | no docs (idx: 8, type: Types.UnixTime) |
| cpu | no docs (idx: 9, type: Thrift.i16) |
| rss | no docs (idx: 10, type: Thrift.i32) |
A sample of all the processes running on a container at a moment in time
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| processes | no docs (idx: 3, type: Thrift.list (Types.Process)) |
A graph of process data over a period of time See Container.getProcessTableGraph
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime) |
| endTime | no docs (idx: 3, type: Types.UnixTime) |
| intervalTime | no docs (idx: 4, type: Thrift.i32) |
| limit | no docs (idx: 5, type: Thrift.i16, optional: 1) |
| metrics | no docs (idx: 6, type: Thrift.list (Types.ProcessTableMetric)) |
| thresholds | no docs (idx: 7, type: Thrift.map (Types.ProcessTableMetric => Thrift.i32)) |
| processes | no docs (idx: 8, type: Thrift.list (Types.ProcessTableGraphProcess)) |
A single process and a list of graph data for metric(s) No context for this data.
| process | no docs (idx: 1, type: Types.Process) |
| data | { $metric: [ [ $offset, $value ], [ $offset, $value ], ... ] } (idx: 2, type: Thrift.map (Types.ProcessTableMetric => Thrift.list (Thrift.list (Thrift.i32)))) |
Current resource usage for a container. The records map could look something like this: { TrafficIncomingBytes: { count: 654593, }, CPU: { used: 28.00, hard: 200.00, }, LoadAverage: { load: 1.8 }, Disk: { unit: MByte, used: 191916.00, soft: 1048576.00, hard: 1048576.00, }, Memory: { unit: Byte, used: 21372928.00, hard: 268435456.00, }, } As you can see, the fields used in the ResourceUsage struct are context sensitive
| time | no docs (idx: 1, type: Types.UnixTime) |
| uptime | Seconds since last reboot (idx: 2, type: Thrift.i32) |
| records | no docs (idx: 3, type: Thrift.map (Types.ResourceUsageType => Types.ResourceUsage)) |
Moment in time resource usage for a container. The records map could look something like this: { TrafficIncomingBytes: { count: 654593 }, CPU: { percent: 18.11 }, LoadAverage: { load: 1.8 }, Disk: { percent: 2.51 }, } This is a different result than ‘ResourceCurrentUsage’, as each record has an average-type value and has no limit or type indication
| startTime | no docs (idx: 1, type: Types.UnixTime) |
| endTime | no docs (idx: 2, type: Types.UnixTime) |
| records | no docs (idx: 3, type: Thrift.map (Types.ResourceUsageType => Types.ResourceUsage)) |
An all-optional representation of the value of a single resource
| unit | no docs (idx: 1, type: Types.ResourceUsageUnit, optional: 1) |
| used | no docs (idx: 2, type: Thrift.double, optional: 1) |
| soft | no docs (idx: 3, type: Thrift.double, optional: 1) |
| hard | no docs (idx: 4, type: Thrift.double, optional: 1) |
| percent | no docs (idx: 5, type: Thrift.double, optional: 1) |
| count | no docs (idx: 6, type: Thrift.i64, optional: 1) |
| load | no docs (idx: 7, type: Thrift.double, optional: 1) |
Base type Thrift.string
Base type Thrift.list (Types.Role)
Base type Thrift.string
A setting catalog item
| id | no docs (idx: 1, type: Types.SettingId) |
| type | no docs (idx: 2, type: Types.SettingType) |
| key | no docs (idx: 3, type: Types.SettingKey) |
| settingClass | no docs (idx: 4, type: Types.SettingClass) |
| name | no docs (idx: 5, type: Types.SettingName) |
| defaultValue | no docs (idx: 6, type: Types.SettingValue, optional: 1) |
| contexts | no docs (idx: 7, type: Thrift.list (Types.ObjectSettingContext)) |
| selectOptions | no docs (idx: 8, type: Thrift.list (Types.SettingSelectOption)) |
| url | no docs (idx: 9, type: Types.URL, optional: 1) |
| description | no docs (idx: 10, type: Thrift.string, optional: 1) |
| settingSubclass | no docs (idx: 11, type: Types.SettingClass, optional: 1) |
Base type Thrift.string
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.map (Types.SettingKey => Types.SettingValue)
Base type Thrift.string
Base type Thrift.string
Select option pair for the setting catalog
| key | no docs (idx: 1, type: Types.SettingSelectKey) |
| value | no docs (idx: 2, type: Types.SettingValue) |
Base type Thrift.string
Base type Thrift.string
Base type Thrift.i16
Base type Thrift.map (Types.SiteAliasId => Types.SiteAlias)
Site Details
| id | no docs (idx: 1, type: Types.SiteId) |
| name | no docs (idx: 2, type: Types.SiteName) |
| hostname | no docs (idx: 3, type: Types.Hostname) |
| stackableHostname | no docs (idx: 4, type: Types.Hostname) |
| status | no docs (idx: 5, type: Types.SiteStatus) |
| address | no docs (idx: 6, type: Types.IPAddress) |
| aliases | no docs (idx: 7, type: Types.SiteAliasList) |
| settings | no docs (idx: 8, type: Types.SettingList) |
| environments | no docs (idx: 9, type: Thrift.list (Types.EnvironmentDetails)) |
| isSSLReserved | no docs (idx: 10, type: Thrift.bool) |
| certificateId | no docs (idx: 11, type: Types.CertificateId, optional: 1) |
Base type Thrift.i16
All the LoadBalancerStatus records that are associated with the live site
| siteId | no docs (idx: 1, type: Types.SiteId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
| frontendStatus | no docs (idx: 3, type: Types.LoadBalancerStatus) |
| backendStatus | no docs (idx: 4, type: Thrift.list (Types.LoadBalancerStatus)) |
Base type Thrift.string
An alternative name for a certificate Provide either ‘dns’ or ‘ip’ but not both.
| dns | no docs (idx: 1, type: Types.DomainName, optional: 1) |
| ip | no docs (idx: 2, type: Types.IPAddress, optional: 1) |
Structure which defines an interval
| startTime | no docs (idx: 1, type: Types.UnixTime) |
| endTime | no docs (idx: 2, type: Types.UnixTime) |
Base type Thrift.string
Base type Thrift.i32
| Types | |
| BillingFailed | The billing failed |
| InvalidArguments |
| message | The text of the error (idx: 1, type: Thrift.string, utf8) |
| argument | The name of the argument that was invalid (idx: 2, type: Thrift.string) |