Jump to: navigation, search

Deployment/Snapshots

API Method Syntax Request Body Response Body HTTP Status Codes Notes
Query Snapshots GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 404 Not Found—could not find specified package ID.
User must have SNAPSHOT_VIEW permission.
Create Snapshot POST [+]Show [+]Show [+]Show
  • 201 - Created - Response body provided
  • 401 - Unauthorized - APIToken not valid
  • 403 - Forbidden - User does not have permission for the specified tenant, or does not have proper permission to perform this operation.
  • 422 - Unprocessable Entry - Field Validation Error
[+]Show
  • 422 - Unprocessable Entry - Rules in package do not validate
[+]Show
User must have SNAPSHOT_CREATE permission.
  • name—Snapshot name cannot contain special characters such as: { } [ ] . * | / : < > ' & due to internal restrictions.
Delete Snapshot DELETE [+]Show N/A N/A
  • 204 No Content—returned if successful operation
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or does not have proper permission to perform this operation.
  • 404 Not Found—could not find specified package ID.
User must have SNAPSHOT_DELETE permission.
Query Deployment History GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant.
  • 404 Not Found—could not find specified package ID.
status
  • SUCCESS—deployment was successful
  • FAILED—deployment failed
  • PARTIAL—deployment was partially successful
  • PENDING—deployment is still processing
  • SCHEDULED—deployment is scheduled
Query Deployment Targets GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant.
type
  • SINGLE—represents a single GRE node target
  • CLUSTER—represents a cluster of GRE nodes
Deploy Rule Package or Snapshot POST [+]Show [+]Show [+]Show
  • 201 Created—Response body provided with deployment ID
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant or does not have proper permission to perform this operation.
  • 404 Not Found—could not find specified package ID or snapshot name
  • 422 Unprocessable Entry—Field Validation Error
[+]Show
  • 422 Unprocessable Entry—Rules in package do not validate
[+]Show
User must have PACKAGE_DEPLOY and SNAPSHOT_VIEW permissions.
  • target—Indicate which GRE or GRE Cluster you want to deploy to. Use "Query Deploy Targets" to get the list of valid targets.
  • snapShotName—To deploy "latest" package, specify "LATEST" as snapshot name (or omit the field).
  • deployScheduledDateTime—To schedule deployment for a future time, pass in scheduledDateTime field in UTC ms since EPOCH. To schedule immediately, omit this field.
This page was last modified on July 30, 2015, at 05:17.

Feedback

Comment on this article:

blog comments powered by Disqus