Package get

Request Information
URL GET {{basepath}}/package/:package
CategoryPackage

Description

Allows you to retrieve a specific package and it's specs. Returns a PackageGetResponse object.

Url variables
:packagebasicthe package you want to retrieve

Example responses

Package get
Request Method & URL
GET {{basepath}}/package/:package
Url variables
:packagebasic1the package you want to retrieve
Response Code:
200 OK
Response Body:
{
    "responseId": "1_f133e4ceea82c615e4d0472a2ea9b5cfd66e5919",
    "status": "ok",
    "message": "The Package is attached",
    "package": {
        "packageId": "basic",
        "type": "plesk",
        "status": "active",
        "spec": [
            {
                "type": "diskspace",
                "value": "1000"
            }
        ],
        "created": 1626272615,
        "modified": 1626272619
    }
}
Package get that does not exist
Request Method & URL
GET {{basepath}}/package/:package
Url variables
:packagebasic1234the package you want to retrieve
Response Code:
404 Not Found
Response Body:
{
    "responseId": "1_f2c74b4d4017fe9c5c09543be3cc1f1debff5675",
    "status": "error",
    "errorCode": "does_not_exist",
    "errorMessage": "This package does not exist"
}