Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 1.76 KB

edgeDeployment.md

File metadata and controls

59 lines (43 loc) · 1.76 KB

Edge Deployment Actions

Details on the various actions that can be performed on the Edge Deployment resource, including the expected parameters and the potential responses.

Contents

Get

Retrieves information on an edge deployment

var params = {
  applicationId: myApplicationId,
  edgeDeploymentId: myEdgeDeploymentId
};

// with callbacks
client.edgeDeployment.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.edgeDeployment.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, edgeDeployment.*, or edgeDeployment.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
edgeDeploymentId string Y ID associated with the edge deployment 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Edge Deployment Edge deployment information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if edge deployment was not found