Skip to content

transaction

Access transactions linked in a chain

Index

Path
GET /v7.0/transactions
Description
List transactions
Authentication required
yes
Scope
transaction#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
transaction
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: 25

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
transaction_chain
Transaction chain
 Resource no
node
Node
 Resource no
type
Type
 Integer no

node, storage or mailer

Default: null
success
Success
 Integer no

Default: null
done
Done
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • waiting
  • done
  • staged

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
transactions
ParameterTypeDescription
id
Id
 Integer
transaction_chain
TransactionChain
 Resource
node
Node
 Resource
user
User
 Resource
type
Type
 Integer node, storage or mailer
name
Name
 String
label
Label
 String
vps
VPS
 Resource
depends_on
Depends on
 Resource
urgent
Urgent
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
success
Success
 Integer
done
Done
 String
input
Input
 String
output
Output
 String
created_at
Created_at
 Datetime
started_at
Started_at
 Datetime
finished_at
Finished_at
 Datetime

Show

Path
GET /v7.0/transactions/{transaction_id}
Description
Show transaction
Authentication required
yes
Scope
transaction#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
transaction
ParameterTypeDescription
id
Id
 Integer
transaction_chain
TransactionChain
 Resource
node
Node
 Resource
user
User
 Resource
type
Type
 Integer node, storage or mailer
name
Name
 String
label
Label
 String
vps
VPS
 Resource
depends_on
Depends on
 Resource
urgent
Urgent
 Boolean
priority
Priority
 Integer Optional priority, used for MX and SRV records
success
Success
 Integer
done
Done
 String
input
Input
 String
output
Output
 String
created_at
Created_at
 Datetime
started_at
Started_at
 Datetime
finished_at
Finished_at
 Datetime