Reblaze REST API
Reblaze REST API operations v2.x
Below are listed the available operations under Reblaze's API. The listings include descriptions, and examples using curl over Bash under Ubuntu 18.
In the commands below, the parameter $API_URL is https://$HOST/api/$KEY, where $HOST refers to the console FQDN and $KEY refers to the API key.
Sites
List Sites
Lists all sites that are currently set up on the management console.
curl -s -XGET $API_URL/sites/list
Duplicate Site
Duplicates/creates new site based on an existing site. You can choose to overwrite the upstream, or use the one that is currently set on the source site. The duplicate site will also create a referring CNAME based on the source site DNS settings.
curl -s -XPOST $API_URL/sites/duplicate -d "canonicalname=src.example.com&newdomain=dst.example.com&upstreamhost=8.8.8.8"
Create Site
Creates a new site based on passed parameters and the selected template.
curl -XPOST $API_URL/sites/create --data-urlencode 'template_id=TEMPLATE_ID' --data-urlencode 'domains=site1.com,site2.com' --data-urlencode 'certificate_id=CERT_ID' --data-urlencode 'upstream_id=UPSTREAM_ID'
Remove Site
Removes the site from the sites list. This operation also removes the referring CNAME.
curl -s -XPOST $API_URL/sites/remove -d "canonical_name=dst.example.com"
Set Names (domain aliases)
Sets the list of domains that a site supports, and replaces any that existed previously. You can add up to 100 domains per site. A domain can also contain wildcards (e.g, *.domain.name).
curl $API_URL/sites/setnames --data "canonicalname=src.example.com&names=www.example.com,www2.example.com"
Add Names (domain aliases)
Adds to the list of domains that a site supports, without replacing any that existed previously. You can have up to 100 domains per site. A domain can also contain wildcards (e.g, *.domain.name).
curl $API_URL/sites/addnames --data "canonicalname=src.example.com&names=www.example.com,www2.example.com"
Get Names (domain aliases)
Returns the list of domains that a site supports.
curl $API_URL/sites/getnames?canonicalname=src.example.com
List Upstream
Lists the upstream settings of a site.
curl $API_URL/sites/listupstream?canonicalname=www.example.com
Set Upstream
Modifies upstream settings. You can add an upstream, change its state, or modify the upstream address. The upstream is a one-line JSON encoded in base64, as shown below. Parameters are described below the code example.
Argument
Description
http_port
Upstream HTTP listening port
https_port
Upstream HTTPS listening port
weight
The relative weight of the upstream for load-balancing purposes within a farm. Reblaze distributes traffic with a round-robin sequence, according to these weights. For example, if two servers are both set to 'weight=1', they will receive equal amounts of traffic. If the first is set to 'weight=3' while the second is set to 'weight=1', the first server will receive three requests for every single request that the second server receives.
fail_timeout
max_fails
The maximum number of failed communication attempts that are allowed for this server. Once this number of failures occurs, Reblaze will consider the server to be inactive. If other servers are available, Reblaze will failover the traffic to them. If this was the only server available, Reblaze will return an error to the client (either 504 Timeout, or 502 Bad Gateway).
monitor_state
This sets the state for Health Monitoring purposes. (This does not specify if the server is up or down; it merely sets the current state as if Health Monitoring had just checked the server and returned that state.) If backup is true, then this value should be either "backup_active" or "backup_down". If backup is false, then this should be 0, or "active_down." ("active_down" means the server is supposed to be active, but is down instead.)
down
The state of the server.
backup
If true, Reblaze will treat this server as a backup. In other words, Reblaze will not attempt to communicate with it unless all the primary servers (i.e., those for which the Backup setting is not set) are unavailable.
host
The server host, as IP/FQDN.
Encode the json with base64:
one_line_json_base64=$( echo $one_line_json | base64 )
And set the upstreams:
curl $API_URL/sites/setupstream --data "back_hosts=$one_line_json_base64&canonicalname=www.example.com"
SSL
List Certificates
Lists the certificates in SSL Management.
curl $API_URL/ssl/list
Add Certificate
curl $API_URL/ssl/add --data-urlencode "cert_body=$SSL_CRT" --data-urlencode "private_key=$SSL_KEY" | awk '{print $4}' | cut -d '"' -f2
Remove Certificate
curl $API_URL/ssl/remove
Replace Certificate
Replace one certificate with another on a passed list of sites and all load balancers.
curl -XPOST $API_URL/ssl/replace --data-urlencode 'new_cert_id=NEW_CERT_ID' --data-urlencode 'old_cert_id=OLD_CERT_ID' --data-urlencode 'sites=site1.com,site2.com'
Attach Certificate
Attaches a domain to a SSL certificate.
curl $API_URL/loadbalancer/attach-certificate --data "canonicalname=$CANONICAL_NAME&sslid=$CERT_ID"
Detach Certificate
Removes an attached domain from SSL.
curl $API_URL/loadbalancer/detach-certificate --data "canonicalname=$CANONICAL_NAME"
System
Publish Changes
curl -XPOST $API_URL/system/publish
Trusted Sources
Get, Add, Delete, Edit trusted sources (nets) for a planet.
Get:
curl -XPOST $API_URL/planet/trusted_net
Add:
curl -XPOST $API_URL/planet/trusted_net --header 'Content-Type: application/json' --data-raw '{ "address": "127.0.0.1", "comment": "Local Host" }'
Edit:
curl PUT $API_URL/planet/trusted_net --header 'Content-Type: application/json' --data-raw '{ "address": "127.0.0.1", "comment": "Local Host" }'
Remove:
curl DELETE $API_URL/planet/trusted_net --header 'Content-Type: application/json' --data-raw '{ "address": "127.0.0.1"}'
Last updated