x360Cloud Public API

Written By Tami Sutcliffe (Super Administrator)

Updated at February 4th, 2025

Overview 

You can now leverage the x360Cloud Public API to integrate with third-party products and gain deeper insights into your protected client organizations.

 
The API currently supports querying key information about client organizations in x360Cloud, including

  • backup health status
  • protected users and shared resources
  • backup data statistics. 

Future releases will introduce protection settings management. This will streamlined operations and reduce your manual intervention.

API key

  • To use the Public API, authorization is required via API key (in a header based format). 
  • The key can be created from within the Settings section of the x360Portal. 
  • To find more information on how to create API keys, visit help.axcient.com for guidelines.


Documentation

  • Supported response codes
  • API query parameters
  • response examples and 
  • objects schema

are documented in accordance with OpenAPI specifications at https://developer.axcient.com/x360cloud.

 


Supported response codes

 

API endpoints

Supported API endpoints are listed at https://developer.axcient.com/x360cloud.

 

Client

Operations related to client organization management.

·        /client

·        /client/{clientId}

·        /client/{clientId}/backup_status

 

User

Operations related to client organization users.

·        /client/{clientId}/user

·        /client/{clientId}/user/{userId}

 

 

Shared Resource

Operations related to client organization shared resources,e.g. SharePoint sites or Google Workspace shared drives.

·        /client/{clientId}/shared_resource

·        /client/{clientId}/shared_resource/{sharedResourceId}


Try it out! (authorization and execution)

After generating an API key, you can start testing the APIs at  https://developer.axcient.com/x360cloud.

 

1. To start, click the Authorize button:


 

2. Enter your API Key into the Value field. 


3. Click Authorize and then close the dialog

A screenshot of a computer

Description automatically generated

 

4. Click the “Try it out” option: 

Choose your preferred filtering settings and click the Execute button for the API endpoint that you would like to try out:

 

After execution, you can view the Request URL and xcopy the cURL command to run the request from the command line.


Additionally, you will see the response from x360Cloud:

 

 

NOTE: Page number (“page”) is starting from 0 and can be set along with page size (“page_size”) in the Parameters list for each API end point:

 

A screenshot of a phone

Description automatically generated

 

Use the "numberOfAvailableResults" count to determine the total number of entities matching the query and filters in the response. Combine this with the "page_size" value to iterate through all pages when retrieving a list of objects from the API.

For example, if "numberOfAvailableResults" is 14 and "page_size" is set to 5, you will need to iterate through 3 pages to retrieve all objects.

A screenshot of a computer program

Description automatically generated


Error codes

Following response codes and error messages are supported.

API endpoint

Response code

Info message

    /client

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  500

Internal service error - Remote service response contains errors

    /client/{clientId}

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  404

Not Found: A client organization with the specified ID {clientId} was not found

  500

Internal service error: Remote service response contains errors

    /client/{clientId}/backup_status

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  404

Not Found: A client organization with the specified ID {clientId} was not found

  500

Internal service error: Remote service response contains errors

      /client/{clientId}/user

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  404

Not Found: Organization was not found

  500

Internal service error: Remote service response contains errors

/client/{clientId}/user/{userId}

  200

Successfully retrieved

403

Forbidden: User lacks permissions

  404

Not Found: {userId}  was not found

Not Found: Organization was not found.

  500

Internal service error: Remote service response contains errors

     /client/{clientId}/shared_resource

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  404

Not Found: Organization was not found

  500

Internal service error: Remote service response contains errors

 /client/{clientId}/shared_resource/{sharedResourceId}

  200

Successfully retrieved

  403

Forbidden: User lacks permissions

  404

Not Found: {sharedResourceId} shared resource was not found

  404

Not Found: Organization was not found

  500

Internal service error: Remote service response contains errors

 

 

Support

Support Contacts:

  • Partner Support: Partners should log a ticket within the x360Portal for assistance.
  • Vendor Support: Vendors should email api@axcient.com for any required support.

 

 

 SUPPORT | 720-204-4500 | 800-352-0248

 

1996