{ "opencollection": "1.0.0", "info": { "name": "Local Management APIs activations plans API", "version": "v1" }, "items": [ { "info": { "name": "plans", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a list of plans", "type": "http" }, "http": { "method": "GET", "url": "https://edge-host-ip:5080/v1/plans", "headers": [ { "name": "ProjectUid", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name" }, { "name": "filters", "value": "", "type": "query", "description": "Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws\n\nServer will be restricted to certain fields based on the indexed data for each resource." }, { "name": "orderBy", "value": "", "type": "query", "description": "Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1" }, { "name": "limit", "value": "", "type": "query", "description": "limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.\nIf more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results." }, { "name": "offset", "value": "", "type": "query", "description": "offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination." }, { "name": "continue", "value": "", "type": "query", "description": "continue token to paginate the subsequent data items" } ] }, "docs": "Retrieves a list of plans" }, { "info": { "name": "Creates a user plan", "type": "http" }, "http": { "method": "POST", "url": "https://edge-host-ip:5080/v1/plans", "headers": [ { "name": "ProjectUid", "value": "" } ] }, "docs": "Creates a user plan" }, { "info": { "name": "Returns the specified plan", "type": "http" }, "http": { "method": "GET", "url": "https://edge-host-ip:5080/v1/plans/:uid", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Returns the specified plan" }, { "info": { "name": "Updates the specified Plan's credit data", "type": "http" }, "http": { "method": "PUT", "url": "https://edge-host-ip:5080/v1/plans/:uid/credits/:creditUid", "params": [ { "name": "uid", "value": "", "type": "path" }, { "name": "creditUid", "value": "", "type": "path" } ] }, "docs": "Updates the specified Plan's credit data" }, { "info": { "name": "Deletes the specified Plan's credit data", "type": "http" }, "http": { "method": "DELETE", "url": "https://edge-host-ip:5080/v1/plans/:uid/credits/:creditUid", "params": [ { "name": "uid", "value": "", "type": "path" }, { "name": "creditUid", "value": "", "type": "path" } ] }, "docs": "Deletes the specified Plan's credit data" }, { "info": { "name": "Updates the specified plan's expiry", "type": "http" }, "http": { "method": "PATCH", "url": "https://edge-host-ip:5080/v1/plans/:uid/expiry", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Updates the specified plan's expiry" }, { "info": { "name": "Adds free credit to the specified plan", "type": "http" }, "http": { "method": "POST", "url": "https://edge-host-ip:5080/v1/plans/:uid/freeCredit", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Adds free credit to the specified plan" }, { "info": { "name": "Updates the specified plan's limit", "type": "http" }, "http": { "method": "PUT", "url": "https://edge-host-ip:5080/v1/plans/:uid/planLimit", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Updates the specified plan's limit" }, { "info": { "name": "Changes the plan type for the specified plan", "type": "http" }, "http": { "method": "PUT", "url": "https://edge-host-ip:5080/v1/plans/:uid/planType", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Changes the plan type for the specified plan" }, { "info": { "name": "Adds renewal data to the existing plan", "type": "http" }, "http": { "method": "PATCH", "url": "https://edge-host-ip:5080/v1/plans/:uid/renewal", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Adds renewal data to the existing plan" }, { "info": { "name": "Adds sla breach credit to the specified plan", "type": "http" }, "http": { "method": "POST", "url": "https://edge-host-ip:5080/v1/plans/:uid/slaCredit", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Adds sla breach credit to the specified plan" } ] } ], "bundled": true }