{ "opencollection": "1.0.0", "info": { "name": "Gremlin agents schedules API", "version": "1.0" }, "items": [ { "info": { "name": "schedules", "type": "folder" }, "items": [ { "info": { "name": "Get all active experiment schedules. This functionality has moved to GET /schedules/attacks/paged.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/attacks", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Create an attack schedule.", "type": "http" }, "http": { "method": "POST", "url": "https://api.gremlin.com/v1/schedules/attacks", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires the privilege [`EXPERIMENTS_RUN`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "This functionality has moved to POST /schedules/attacks.", "type": "http" }, "http": { "method": "POST", "url": "https://api.gremlin.com/v1/schedules", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires the privilege [`EXPERIMENTS_RUN`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Get all scenario schedules. This functionality has moved to GET /schedules/scenarios/paged.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/scenarios", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Create a scenario schedule.", "type": "http" }, "http": { "method": "POST", "url": "https://api.gremlin.com/v1/schedules/scenarios", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires the privilege [`SCENARIOS_RUN`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Get an attack schedule.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/attacks/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Delete an attack schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.gremlin.com/v1/schedules/attacks/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`HALT_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "This functionality has moved to GET /schedules/attacks/{guid}.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "This functionality has moved to DELETE /schedules/attacks/{guid}", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.gremlin.com/v1/schedules/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`HALT_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Get a scenario schedule.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/scenarios/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Update a scenario schedule.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.gremlin.com/v1/schedules/scenarios/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires the privilege [`SCENARIOS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Delete a scenario schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.gremlin.com/v1/schedules/scenarios/:guid", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Enable a scenario schedule.", "type": "http" }, "http": { "method": "POST", "url": "https://api.gremlin.com/v1/schedules/scenarios/:guid/enabled", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Disable a scenario schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.gremlin.com/v1/schedules/scenarios/:guid/enabled", "params": [ { "name": "guid", "value": "", "type": "path", "description": "This value represents the globally unique identifier of the record to fetch." }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "This functionality has moved to GET /schedules/attacks.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/active", "params": [ { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Paginated endpoint for listing a team's experiment schedules ordered by trigger time.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/attacks/paged", "params": [ { "name": "pageSize", "value": "None (unlimited)", "type": "query", "description": "This value determines how many results will be returned per call." }, { "name": "pageToken", "value": "None (returns first page)", "type": "query", "description": "Pass the pageToken to get the next page of experiment schedules" }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`EXPERIMENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Paginated endpoint for listing a team's scenario schedules ordered by trigger time.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/scenarios/paged", "params": [ { "name": "pageSize", "value": "None (unlimited)", "type": "query", "description": "This value determines how many results will be returned per call." }, { "name": "pageToken", "value": "None (returns first page)", "type": "query", "description": "Pass the pageToken to get the next page of scenario schedules" }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SCENARIOS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" }, { "info": { "name": "Paginated endpoint for listing a team's service schedules ordered by trigger time.", "type": "http" }, "http": { "method": "GET", "url": "https://api.gremlin.com/v1/schedules/services/paged", "params": [ { "name": "pageSize", "value": "None (unlimited)", "type": "query", "description": "This value determines how many results will be returned per call." }, { "name": "pageToken", "value": "None (returns first page)", "type": "query", "description": "Pass the pageToken to get the next page of service schedules" }, { "name": "teamId", "value": "", "type": "query", "description": "Required when using company session token." } ] }, "docs": "Requires the privilege [`SERVICES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)" } ] } ], "bundled": true }