Domain TAR files

Vodia PBX API (version 58.0 and above)

GET (Download the domain TAR file)

rest/system/domains/domain_name

Parameters

FieldTypeDescription

domain_nameStringName of the existing domain.

Success (200 OK)

Example Request: curl -u admin:password GET -H "Content-Type: application/x-tar" http://<PBX_IP>/rest/system/domains/<DOMAIN_NAME> > curl.tar

 

 

In the above API, the curl.tar is name of the file which is the name of that particular domain tar file.

 

 

ResponseCodeDescription

Success200OK

Invalid ID supplied400Only authenticated a Admins can access the data

Permission Denied403Forbidden

Not Found404The id of the User was not found or there are errors in the URL.

POST (Upload the domain TAR file)

Upload

rest/system/domains/preexisting_domain_name

Example:

For uploading the tar file, the domain with the desired name should be already existing. 

You can then upload the tar file previously saved as curl.tar or by any other name of your choice.

Request:

curl -u admin:password --upload-file curl.tar http://<PBX_IP>/rest/system/domains/<PRE_EXISTING_DOMAIN_NAME>

Response:

ResponseCodeDescription

Success200OK

Invalid ID supplied400Only authenticated a Admins can access the data

Permission Denied403Forbidden

Not Found404The id of the User was not found or there are errors in the URL.