Knowledge Base

Xcitium Backup API Reference

When you want to automate the management of Xcitium Backup orders through API integrations. This article explains the available Xcitium Backup API operations, including order creation, suspension, unsuspension, renewal, deletion, and Single Sign-On (SSO) access.

Overview

This document describes the REST APIs for managing Xcitium orders via the obox reseller platform.

Base URL:https://httpapi.com/restapi/product/xcitiumbackup

Common Authentication Parameters

All endpoints require the following query parameters for authentication:

Parameter	Description
`auth-userid`	Reseller ID
`api-key`	Reseller API key

Endpoints

1. Add Order

Creates a new Xcitium order for a customer.

Method:POST
URL:/restapi/product/xcitiumbackup/order
Content-Type:application/x-www-form-urlencoded

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key
`domain-name`	Yes	Domain name to associate with the order
`customer-id`	Yes	ID of the customer placing the order
`plan-id`	Yes	ID of the Xcitium plan
`noOfMonths`	Yes	Subscription duration in months (e.g. 6)
`invoice-option`	Yes	Invoice generation option (e.g.`NoInvoice`)
`additional-param-json`	No	URL-encoded JSON string for extra parameters (e.g.`{"deletecodeguard": true}`)

Example Request

POST https://httpapi.com/restapi/product/xcitiumbackup/order
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}
  &domain-name=example.com
  &customer-id=321997
  &plan-id={{xcitium_planid}}
  &noOfMonths=6
  &invoice-option=NoInvoice

2. Suspend Order

Suspends an active Xcitium order.

Method:PATCH
URL:/restapi/product/xcitiumbackup/order/{orderid}/suspend
Content-Type:application/x-www-form-urlencoded

Path Parameters

Parameter	Description
`orderid`	The ID of the order to suspend

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key

Example Request

PATCH https://httpapi.com/restapi/product/xcitiumbackup/order/854193/suspend
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}

3. Unsuspend Order

Reactivates a suspended Xcitium order.

Method:PATCH
URL:/restapi/product/xcitiumbackup/order/{orderid}/unsuspend
Content-Type:application/x-www-form-urlencoded

Path Parameters

Parameter	Description
`orderid`	The ID of the order to unsuspend

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key

Example Request

PATCH https://httpapi.com/restapi/product/xcitiumbackup/order/854193/unsuspend
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}

4. Delete Order

Permanently deletes an Xcitium order.

Method:DELETE
URL:/restapi/product/xcitiumbackup/order/{orderid}
Content-Type:application/x-www-form-urlencoded

Path Parameters

Parameter	Description
`orderid`	The ID of the order to delete

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key

Example Request

DELETE https://httpapi.com/restapi/product/xcitiumbackup/order/854151
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}

5. Renew Order

Renews an existing Xcitium order for a specified number of months.

Method:PATCH
URL:/restapi/product/xcitiumbackup/order/{orderid}/tenure/{noOfMonths}
Content-Type:application/x-www-form-urlencoded

Path Parameters

Parameter	Description
`orderid`	The ID of the order to renew
`noOfMonths`	Number of months to renew for (e.g. 3)

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key

Example Request

PATCH https://httpapi.com/restapi/product/xcitiumbackup/order/854151/tenure/3
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}

6. Get SSO URL

Returns a Single Sign-On (SSO) URL to log the customer directly into the Xcitium dashboard for a given order.

Method:GET
URL:/restapi/product/xcitiumbackup/order/{orderid}/sso-url

Path Parameters

Parameter	Description
`orderid`	The ID of the order to generate SSO access for

Query Parameters

Parameter	Required	Description
`auth-userid`	Yes	Reseller ID
`api-key`	Yes	Reseller API key

Example Request

GET https://httpapi.com/restapi/product/xcitiumbackup/order/1666893/sso-url
  ?auth-userid={{reseller_id}}
  &api-key={{reseller_api_key}}

Summary Table

Operation	Method	Endpoint
Add Order	`POST`	`/restapi/product/{product_key}/order`
Suspend Order	`PATCH`	`/restapi/product/{product_key}/order/{orderid}/suspend`
Unsuspend Order	`PATCH`	`/restapi/product/{product_key}/order/{orderid}/unsuspend`
Delete Order	`DELETE`	`/restapi/product/{product_key}/order/{orderid}`
Renew Order	`PATCH`	`/restapi/product/{product_key}/order/{orderid}/tenure/{noOfMonths}`
Get SSO URL	`GET`	`/restapi/product/{product_key}/order/{orderid}/sso-url`

Did you find this article helpful?