Embedded Deployment Actions

https://api.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_ID

Below are the various requests that can be performed against the Embedded Deployment resource, as well as the expected parameters and the potential responses.

Get

Retrieves information on an embedded deployment

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_ID

Authentication

A valid api access token is required to access this endpoint. 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.

Request Path Components

Path Component Description Example
APPLICATION_ID ID associated with the application 575ec8687ae143cd83dc4a97
EMBEDDEDDEPLOYMENTID ID associated with the embedded deployment 575ed78e7ae143cd83dc4aab

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_ID

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

Was this page helpful?


Still looking for help? You can also search the WEGnology Forums or submit your question there.