Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.59 KB

embeddedDeployment.md

File metadata and controls

49 lines (34 loc) · 1.59 KB

Embedded Deployment Actions

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

Contents

Get

Retrieves information on an embedded deployment

result = client.embedded_deployment.get(
    applicationId=my_application_id,
    embeddedDeploymentId=my_embedded_deployment_id)

print(result)

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, embeddedDeployment.*, or embeddedDeployment.get.

Available Parameters

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

Successful Responses

Code Type Description
200 Embedded Deployment Embedded deployment information

Error Responses

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