Models

Decentralized Identifier (DID) of the user, used when the user type is DID.
example: did:key:z6MkwQq5dYjR5Jxk8V6YtRj5X9V6Jc2xC3L2QkP2sEwYzBq1

Email address of the user.
example: [email protected]

Full name of the user.
required: true
example: Jane Doe

Password for the new user.
example: StrongPassword123!

Identifier of the role assigned to this user.
required: true
example: 2

Type of user (e.g., did, api, human).
example: api
enum: did, api, human

Reference ID for the payment transaction.
example: pay_abc123xyz

Tax identifier associated with the billing account.
example: EU123456789

VAT or tax amount applied to this invoice.
example: "20.00"

Identifier of the account associated with this invoice.
example: 5

Start date of the billing period.
example: 2025-06-01T00:00:00Z

Reference Type: InvoiceItem

List of individual items billed within this invoice.
example: {"plan_id":"2","amount":"50.00","billing_for":"Jun 2025"}

Human-readable invoice number.
example: INV-2025-0001

Timestamp when the invoice was paid, if applicable.
example: 2025-07-01T10:45:00Z

The billing month this invoice covers.
example: 2025-06-01T00:00:00Z

Timestamp when the invoice was created.
example: 2025-06-30T12:00:00Z

Discount applied to the subtotal (if any).
example: "5.00"

Remaining unpaid amount for this invoice.
example: "0.00"

Total invoice amount after taxes and discounts.
example: "115.00"

Due date for payment.
example: 2025-07-01T00:00:00Z

Subtotal amount before taxes and discounts.
example: "100.00"

End date of the billing period.
example: 2025-06-30T23:59:59Z

Unique system-wide identifier for the invoice.
example: inv_9f8e7d6c5b4a3

Timestamp when the invoice was last updated.
example: 2025-07-01T11:00:00Z

Unique identifier of the invoice.
example: 1001

Indicates whether the invoice has been fully paid.
example: true

Name of the account.
example: Serverista Account Eu

Reference Type: Role

Role within the current account.
example: Admin

Unique Account ID.
example: 5

Reference Type: Permission

The permission associated with this record.

ID of the permission in this relationship.
example: 5

Reference Type: Role

The role associated with this record.
example: Role object

ID of the role in this relationship.
example: 1

Timestamp when this association was last updated.
example: 2025-10-25T09:21:10Z

Timestamp when this association was created.
example: 2025-01-15T13:45:30Z

Timestamp when the user was created
example: 2023-01-01T12:00:00Z

Unique user ID
example: 42

Type of user (e.g., human, api, did)
example: api
enum: human,api,did

Timestamp when the user was last updated
example: 2023-01-05T12:00:00Z

User email address
example: [email protected]

Whether the user is created with sso
example: false

User’s last name
example: Doe

User’s first name
example: John

Whether the use has sys access
example: false

Timestamp when the account was last updated
example: 2023-01-10T12:00:00Z

Street address of the account
example: 123 Main Street

Timestamp when the account was created
example: 2023-01-01T12:00:00Z

Unique identifier for the account
example: 2321

Contact phone number
example: +49 30 123456

Tax identification number
example: DE123456789

Company name associated with the account
example: Serverista

Country of the account
example: Germany

Postal or ZIP code
example: 10115

Indicates if automatic payments are enabled
example: false

City of the account
example: Berlin

Full name of the account owner
example: John Doe

Indicates if the account is verified
example: true

Available credits for the account
example: 1500

State or province
example: Berlin

A short description of the role and its purpose.
example: Full access to all administrative features.

Name of the role to be created.
required: true
example: Administrator

List of permission IDs to associate with the role.
example: 1, 2, 3

Reference Type: AdditionalUserInfo

Additional details about the user such as DID and last login timestamp.
example: AdditionalUserInfo object

Reference Type: User

The core user information.
example: User object

The management action to perform (e.g., start, stop, reboot, delete, reinstall).
required: true
example: START
enum: START,STOP,RESTART,DELETE,REINSTALL

Unique identifier of the server.
example: 101

Reference Type: Plan

The plan details associated with this server.

Identifier of the account that owns this server.
example: 5

Timestamp when the server was created.
example: 2025-10-01T12:30:00Z

Indicates whether the server's firewall is enabled.
example: true

Reference Type: SecurityGroup

List of security groups associated with this server.
example: {SecurityGroup}

Timestamp when the server was last updated.
example: 2025-10-31T18:22:00Z

Virtual Machine ID in the underlying infrastructure (optional).
example: 98765

Reference Type: KeyValue

Key-value metadata related to the server.
example: {"name":"OS","value":"Ubuntu 24.04 LTS"}

Identifier of the order related to this server.
example: 43

Identifier of the plan associated with this server.
example: 2

Timestamp of the most recent status change.
example: 2025-10-31T15:04:05Z

Custom name defined by the user for this server.
example: production-web-01

The public or private IP address assigned to the server.
example: 192.168.1.10

Current operational status of the server (e.g., running, stopped, provisioning).
example: running

Unique internal identifier for the server.
example: 123456

Identifier of the user who created or manages this server.
example: 12

IDs of the tags.
required: true
example: 1, 2, 3

URL to author image
example: https://serverista.com/alice.png

Author name
example: Alice Smith

URL for the category
example: /categories/servers

Publication date
example: October 25, 2025

URL to blog image
example: https://serverista.com/cover1.png

Indicates if the post is featured
example: true

URL to author page
example: /authors/alice-smith

Category name
example: Servers

Timestamp when the post was created
example: 2025-10-20T12:00:00Z

Full datetime of publication
example: 2025-10-25T10:00:00Z

Short description of the post
example: Learn the basics of Virtual Networking.

URL for the blog post
example: /blog/serverista-introduction

Unique blog post ID
example: 1

Estimated reading time
example: 5 min read

Full content of the blog post (HTML)
example: This is a detailed guide on Serverista...

Short name for URL-friendly identifiers
example: go-introduction

Blog post title
example: Getting Started with Serverista

Timestamp when the post was last updated
example: 2025-10-25T12:00:00Z

Number of servers to create.
required: true
example: 3

Optional name to assign to the server.
example: web-server-01

Operating system to install on the server.
required: true
example: Ubuntu 24.04 LTS

Identifier of the selected server plan.
required: true
example: 2

Optional scripts to run on the server.
example: sudo apt update

The SSH public key to be added to the server for authentication.
required: true
example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC8Dk7wF2X9nX2d1J9H4j6bYzVZt5F2ZpHZQ4xS9oX+5j [email protected]

List of tag IDs to associate with the server.
example: 1, 2, 3

Source IP address or CIDR range.
example: 0.0.0.0/0

Optional comment or description for the rule.
example: Allow SSH access from anywhere.

Indicates whether this rule is enabled.
example: true

The network protocol this rule applies to.
example: tcp
enum: tcp,udp,icmp,icmpv6,ip,esp,ah,sctp,gre

Source port or port range.
example: ""

The action to take when this rule matches traffic.
example: ACCEPT
enum: ACCEPT,DROP,REJECT

Destination IP address or CIDR range.
example: ""

The direction of traffic the rule applies to.
example: in
enum: in,out

Destination port or port range.
example: 22

Description of the security group and its purpose.
example: Security group for all frontend web servers.

Indicates whether the security group is enabled upon creation.
example: true

Name of the security group.
required: true
example: web-servers

Reference Type: FirewallRule

List of firewall rules to associate with the security group.
example: {"action":"ACCEPT","direction":"in","proto":"tcp","dport":"80","source":"0.0.0.0/0","enable":true,"comment":"Allow HTTP traffic"}

Number of items per page
example: 10

Current page number
example: 1

Total number of items
example: 150

Total number of pages
example: 15

Reference Type: SecurityGroup

List of security groups returned for the current page.
example: {SecurityGroup}

Current Unix timestamp on the server
example: 1735123456

New tax identification number
example: DE123456789

New country
example: Germany

New full name for the account
example: John Doe

New state or province
example: Berlin

New street address
example: 123 Main Street

New city
example: Berlin

New company name
example: Serverista GmbH

New phone number
example: +49 30 123456

New postal code
example: 10115

Reference Type: Key

The key information, including metadata and public key details.

The private key content (only returned once upon key creation).
example: -----BEGIN OPENSSH PRIVATE KEY-----
MIIEvgIBADANBgkq...
-----END OPENSSH PRIVATE KEY-----

Indicates whether the operation was successful.
example: true

Unique identifier of the initiated management action.
example: 9b73cfe2a7d84b1c92d3f61234a5efc2

Number of servers or instances to create for this plan.
example: 3

Timestamp when this order plan item was created.
example: 2025-10-31T14:25:00Z

Unique identifier of the order plan item.
example: 101

User-defined name for the deployed resource(s).
example: frontend-node

Identifier of the order this plan belongs to.
example: 42

Identifier of the selected plan.
example: 2

SSH public key for server access.
example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC8Dk7wF2X9nX2d1J9H4j6bYzVZt5F2ZpHZQ4xS9oX+5j [email protected]

Timestamp when this order plan item was last updated.
example: 2025-11-01T09:40:00Z

Operating system to be installed.
example: Ubuntu 24.04 LTS

Reference Type: Plan

The plan details associated with this order item.

Optional scripts to execute after provisioning.
example: apt update && apt install -y nginx

Brand or type of the payment method (e.g., Visa, Mastercard, etc.).
example: Visa

Indicates whether this is the user's default payment method.
example: true

Expiration date of the payment method in MM/YY format.
example: 12/27

Unique identifier of the payment method.
example: 123

Last four digits of the payment method number.
example: 4242

Identifier of the account that owns this ticket.
example: 5

Detailed description or content of the issue.
example: I tried to connect to my server via SSH but it keeps timing out.

Reference Type: Attachment

List of file attachments associated with this ticket.

Unique identifier of the ticket.
example: 101

Reference Type: Reply

List of replies associated with this ticket.

Current status of the ticket (e.g., open, closed).
example: open

Subject or title of the support ticket.
example: Cannot access my server

Unique case identifier, typically auto-generated.
example: CASE-5-0001

Timestamp when the ticket was created.
example: 2025-11-01T12:30:00Z

Timestamp when the ticket was last updated.
example: 2025-11-01T14:45:00Z

Identifier of the user who created the ticket.
example: 42

Indicates whether the firewall should be enabled or disabled for the server.
example: true

List of security group IDs to associate with the server's firewall.
example: 1, 2, 3

Color associated with the tag.
example: #FF0000

Data associated with the tag, can be anything in string format.
example: {"key1":"value1","key2":"value2"} or "expires_at:2025-12-31T23:59:59Z"

Name of the tag.
required: true
example: production

List of service IDs to associate with the tag.
example: 1, 2, 3

Decentralized Identifier (DID) associated with the user.
This field is populated only if the user type is DID.
example: did:key:z6MkwQq5dYjR5Jxk8V6YtRj5X9V6Jc2xC3L2QkP2sEwYzBq1

The timestamp of the user's last successful login.
example: 2025-10-31T15:04:05Z

Reference Type: Role

Role within the current account.
example: Role object

Indicates whether the operation was successful.
example: true

A human-readable message describing the result of the operation.
example: User created successfully.

Reference Type: Attachment

List of file attachments associated with this reply.

Unique identifier of the reply.
example: 202

Identifier of the parent ticket.
example: 101

Reference Type: User

User details of the reply author.

Identifier of the user who created the reply.
example: 42

Identifier of the account associated with this reply.
example: 5

Content or message of the reply.
example: Please try rebooting your VM and check if the issue persists.

Timestamp when the reply was created.
example: 2025-11-01T13:00:00Z

Timestamp when the role was last updated.
example: 2025-10-25T09:21:10Z

Timestamp when the role was created.
example: 2025-01-15T13:45:30Z

Email of the user who created this role.
example: [email protected]

Description of the role’s purpose or scope.
example: Full administrative access

Name of the role.
example: Admin

Indicates if this is a system-defined role.
example: true

ID of the account this role belongs to.
example: 42

ID of the user who created this role.
example: 1001

Name of the user who created this role.
example: John

Unique identifier for the role.
example: 1

Reference Type: RolePermission

List of role-permission associations.

Identifier of the new role to assign to the user.
required: true
example: 3

Unique identifier of the attachment.
example: 501

Identifier of the ticket or reply that owns this attachment.
example: 202

Type of the owner entity ("tickets" or "replies").
example: replies

Globally unique identifier for the attachment file.
example: att_9f8e7d6c5b4a3

Timestamp when the file was uploaded.
example: 2025-11-01T13:05:00Z

Original name of the uploaded file.
example: error_log.txt

Name of the key-value pair.
example: OS

Value associated with the key.
example: Ubuntu 22.04

Disk read throughput (in kilobytes per second) at each timestamp.
example: 35.4, 40.1, 38.9

Disk write throughput (in kilobytes per second) at each timestamp.
example: 20.7, 25.3, 22.8

Total available memory (in megabytes).
example: 2048

Memory used (in megabytes) at each timestamp.
example: 512, 768, 1024

Network inbound traffic (in kilobits per second) at each timestamp.
example: 120.4, 256.8, 310.2

Network outbound traffic (in kilobits per second) at each timestamp.
example: 98.3, 210.5, 275.6

List of timestamps (in RFC3339 format) corresponding to each metric data point.
example: "2025-10-31T15:00:00Z", "2025-10-31T15:05:00Z", "2025-10-31T15:10:00Z"

CPU usage percentage at each timestamp.
example: 12.5, 35.7, 42.3

Unique identifier for the permission.
example: 5

Name of the permission.
example: role:update

Description of what this permission allows.
example: Allows update of role

Type of the plan (VPS or Dedicated Server)
example: VPS
enum: VPS,Dedicated Server

Reference Type: KeyValue

Array of key val JSON data associated with the plan
example: {"name":"OS", "val": "Ubuntu 24.04 LTS"}, {}

Description of the plan
example: Suitable for medium businesses

Unique plan ID
example: 1

Name of the plan
example: Dedicated VPS 1

Monthly Price of the plan
example: 29.99

Identifier of the account that owns this tag.
example: 5

Color associated with the tag.
example: #FF0000

Identifier of the user who created this tag.
example: 12

Data associated with the tag, can be anything in string format.
example: {"key1":"value1","key2":"value2"} or "expires_at:2025-12-31T23:59:59Z"

Unique identifier of the tag.
example: 1

Name of the tag.
example: production

New name to assign to the server.
required: true
example: backend-node-01

New last name
example: Doe

New first name
example: John

New password
example: securepassword123

New email address
example: [email protected]

Reference Type: User

The currently authenticated user details.
example: User object

Reference Type: Account

The account currently in context for the user.
example: Account object

Reference Type: Membership

List of memberships showing the user’s access to various accounts.
example: {m1}, {m2}

Identifier of the associated plan.
example: "basic-vm-2cpu"

Timestamp when the invoice item was last updated.
example: 2025-07-01T09:00:00Z

Amount charged for this item.
example: "50.00"

Display label for the billing period (for UI/invoice PDF).
example: "Jun 2025"

Billing month for this invoice item.
example: 2025-06-01T00:00:00Z

Timestamp when the invoice item was created.
example: 2025-06-30T12:10:00Z

Unique identifier of the invoice item.
example: 2001

Identifier of the parent invoice.
example: 1001

Identifier of the billed service.
example: 301

Fingerprint of the key, typically generated from the public key.
example: SHA256:QmV+5BHw8uBfsh7zv5yykYJbHq4qY7AbvWzHzOZ2OYo

Unique identifier of the key.
example: 101

Descriptive name assigned to the key.
example: production-deploy-key

Public key content.
example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFaQhFhW9kzO9Y7u7fQ4x9TXhVhS1eUQhQxF9DJ3yN2 [email protected]

Timestamp when the key was last updated.
example: 2025-11-01T14:00:00Z

Identifier of the user who owns this key.
example: 42

Identifier of the account associated with this key.
example: 5

Timestamp when the key was created.
example: 2025-11-01T12:30:00Z

API key associated with the created user, used for authentication.
example: 51HhG7Qp4WzN1X9z0T8lKQ8mUu7p5VZ2Y...

Unique identifier of the newly created user.
example: 123

Error code or message
example: invalid_request

Map of field names to error messages
example: {"email": "invalid format"}

Name of the image
example: Ubuntu 24.04 LTS

Identifier of the account associated with the order.
example: 5

Timestamp when the order was created.
example: 2025-10-31T14:23:00Z

Unique identifier of the order.
example: 42

Reference Type: OrderPlan

List of plans or services included in the order.
example: {OrderPlan}

Globally unique identifier for the order.
example: 88-77045-10138

Timestamp when the order was last updated.
example: 2025-11-01T09:45:00Z

Identifier of the user who placed the order.
example: 12

International calling code for the country
example: 49

ISO 3166-1 Alpha-2 country code (two-letter code)
example: DE

ISO 3166-1 Alpha-3 country code (three-letter code)
example: DEU

ISO 3166-1 numeric country code
example: 276

Name of the country
example: Germany

Standard VAT (Value Added Tax) rate in percentage
example: 19.0

Descriptive name for the key.
required: true
example: production-deploy-key

The public key content (required for SSH keys).
example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFaQhFhW9kzO9Y7u7fQ4x9TXhVhS1eUQhQxF9DJ3yN2 [email protected]

Type of the key (e.g., generate, import).
required: true
example: generate
enum: generate,import

Data associated with the tag, can be anything in string format.
example: {"key1":"value1","key2":"value2"} or "expires_at:2025-12-31T23:59:59Z"

Name of the tag.
required: true
example: production

List of service IDs to associate with the tag.
example: 1, 2, 3

Color associated with the tag.
example: #FF0000

Optional message or description related to the payment.
example: Payment successfully processed via Stripe.

Remaining outstanding amount after payment.
example: "0.00"

Indicates whether the invoice is paid.
example: true

Reference ID for the payment transaction.
example: pay_9f8e7d6c5b4a3

Action to take when the rule matches (ACCEPT, DROP, REJECT).
example: ACCEPT

Traffic direction this rule applies to (in, out).
example: in

Indicates whether this rule is enabled.
example: true

Network protocol the rule applies to (tcp, udp, icmp).
example: tcp

Identifier of the security group this rule belongs to.
example: 10

Source port or range.
example: ""

Optional comment describing the purpose of this rule.
example: Allow SSH access from anywhere.

Destination IP or CIDR range.
example: "0.0.0.0/0"

Destination port or range.
example: 22

Unique identifier of the firewall rule.
example: 55

Source IP or CIDR range.
example: 0.0.0.0/0

Reference Type: Server

List of servers associated with this security group.
example: {"id":101,"user_defined_name":"production-web-01"}

Timestamp when the security group was last updated.
example: 2025-10-31T15:00:00Z

Identifier of the account that owns this security group.
example: 5

Timestamp when the security group was created.
example: 2025-09-01T10:00:00Z

Identifier of the user who created this security group.
example: 12

Description of the security group.
example: Default security group for all new servers.

Unique identifier of the security group.
example: 10

Name of the security group.
example: default

Reference Type: Rule

List of firewall rules associated with this security group.
example: {"id":1,"action":"ACCEPT","proto":"tcp","dport":"22"}

Description of the role.
required: true
example: Read all servers

Name of the role.
required: true
example: Administrator

List of permission IDs to associate with this role.
example: 1, 2, 3

New status of the ticket.
required: true
example: closed

Reference Type: BlogPost

List of regular blog posts
example: { "id": 2, "title": "Advanced Networking Tips" }

Total number of items
example: 150

Total number of pages
example: 15

Reference Type: BlogPost

List of featured blog posts
example: { "id": 1, "title": "Getting Started with Serverista" }

Number of items per page
example: 10

Current page number
example: 1