Sha256: 920b9e463b91b30f80ae4d86a61c1e70974a99bd15f5f99fe06c2e02a7bfaf6b

Contents?: true

Size: 1.53 KB

Versions: 29

Compression:

Stored size: 1.53 KB

Contents

# 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](#get)

<br/>

## Get

Retrieves information on an edge deployment

```ruby
result = client.edge_deployment.get(
  applicationId: my_application_id,
  edgeDeploymentId: my_edge_deployment_id)

puts 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, 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](_schemas.md#edge-deployment) | Edge deployment information |

#### Error Responses

| Code | Type | Description |
| ---- | ---- | ----------- |
| 400 | [Error](_schemas.md#error) | Error if malformed request |
| 404 | [Error](_schemas.md#error) | Error if edge deployment was not found |

Version data entries

29 entries across 29 versions & 1 rubygems

Version Path
losant_rest-1.21.0 docs/edgeDeployment.md
losant_rest-1.20.1 docs/edgeDeployment.md
losant_rest-1.20.0 docs/edgeDeployment.md
losant_rest-1.19.9 docs/edgeDeployment.md
losant_rest-1.19.8 docs/edgeDeployment.md
losant_rest-1.19.6 docs/edgeDeployment.md
losant_rest-1.19.4 docs/edgeDeployment.md
losant_rest-1.19.3 docs/edgeDeployment.md
losant_rest-1.19.2 docs/edgeDeployment.md
losant_rest-1.19.1 docs/edgeDeployment.md
losant_rest-1.19.0 docs/edgeDeployment.md
losant_rest-1.18.0 docs/edgeDeployment.md
losant_rest-1.17.5 docs/edgeDeployment.md
losant_rest-1.17.4 docs/edgeDeployment.md
losant_rest-1.17.3 docs/edgeDeployment.md
losant_rest-1.17.2 docs/edgeDeployment.md
losant_rest-1.17.1 docs/edgeDeployment.md
losant_rest-1.17.0 docs/edgeDeployment.md
losant_rest-1.16.6 docs/edgeDeployment.md
losant_rest-1.16.5 docs/edgeDeployment.md