Syminet Cloud API Documentation

Welcome to the Syminet cloud API. The API is a modern, RESTful JSON interface providing endpoints for the panel functions and more. Developers can use the API to write their own applications, which seamlessly interface with the Syminet Cloud backend, automating and enhancing it’s capabilities.

Note

Subusers do not have API access enabled by default. You can enable it in the panel on the user permissions page. Also, if an Admin user revokes API Access to a User, their token is not deleted. Upon re-enabling API Access for the account, their token will be re-enabled.

Overview:

• Get Started
  • Create an API Token
  • Delete or rename a Token
• Workflow
  • Making requests
  • Example Code Blocks
  • Formatting JSON Responses
  • Environment
• Slug Endpoints
  • Regions
  • Slice Distribution Images
  • Slice Sizes

Compute Slices:

• Create Slice
  • From Distribution
  • From Snapshot
  • From Backup
• List All Slices
• Delete Slice
• Slice Functions
  • Fetch a Slice
  • Rename a Slice
  • Power Control
    • Power Off
    • Power On
    • Reboot
  • Firewall Details for a Slice
  • List Slice Volumes
  • Resize a Slice
  • Clone a Slice
  • Rescue a Slice
  • Rebuild a Slice
  • Assign Private IP
  • Backups
    • List Backups for a Slice
    • Restore a Slice from Backup
    • Enable Backups for a Slice
    • Disable Backups for a Slice
  • List Neighbors

Images:

• Snapshots
  • Create a Snapshot
  • List All Snapshots
  • List Snapshots for a Slice
  • Restore a Slice from Snapshot
  • Rename a Snapshot
  • Delete a Snapshot
• Backups
  • List Backups for a Slice
  • Restore a Slice from Backup
  • Enable Backups for a Slice
  • Disable Backups for a Slice

Volumes:

• Create Volume
• List All Volumes
• Delete Volume
• Volume Functions
  • Fetch a Volume
  • List Volumes for a Slice
  • Attach a Volume
  • Detach a Volume
  • Rename a Volume

Users:

• Create User
• List All Users
• Delete User
• User Functions
  • Fetch a User
  • List User Permissions
  • Edit Profile
  • Revoke all Permissions
  • Edit Permissions

Networking:

• FlexIPs
  • List all FlexIPs
  • Fetch a FlexIP
  • Assign
  • Reassign
  • Unassign
  • Delete
• Firewalls
  • Create a Firewall
  • List All Firewalls
  • Delete a Firewall
  • Fetch a Firewall
  • Rename a Firewall
  • Assign Firewall
  • Unassign Firewall
  • Update Firewall Rules

Domains:

• Create Domain
• List All Domains
• Delete Domain
• Domain Records
  • Create Domain Record
    • A Record
    • CAA Record
    • CNAME Record
    • MX Record
    • NS Record
    • SRV Record
    • SSHFP Record
    • TXT Record
  • List Domain Records
  • Delete Domain Record
• Domain Functions
  • Disable a Domain
  • Enable a Domain

symBalancers:

• Create symBalancer
• List symBalancers
• Delete symBalancer
• symBalancer Functions
  • Rename symBalancer
  • Backend Servers
    • Backend Server List
    • Add Server
    • Remove Server
    • Set Server States
      • Set State READY
      • Set state DRAIN
      • Set state MAINT
  • Ports
    • Port List
    • Add Port
    • Delete Port
  • Settings / Health Checks
    • Settings List
    • Update Settings / Health Checks
  • Certificates
    • Certificate List
    • Add Certificate
    • Delete Certificate
  • Graphs

Billing:

• Current Balances
• List All Invoices
• Get Invoice CSV
• Get Invoice PDF