Skip to content

Latest commit

 

History

History
394 lines (302 loc) · 16.8 KB

schedules.md

File metadata and controls

394 lines (302 loc) · 16.8 KB
Raw

apimetrics schedules

Manage project schedules.

apimetrics schedules

List schedules.

USAGE
  $ apimetrics schedules [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-p <value>]

FLAGS
  -p, --project-id=<value>  ID of project to read. Overrides apimetrics config project set. Can be found in the Project
                            Settings web page under the admin section or by using the command `apimetrics projects
                            --columns name,id`.
  -x, --extended            show extra columns
      --columns=<value>     only show provided columns (comma-separated)
      --csv                 output is csv format [alias: --output=csv]
      --filter=<value>      filter property by partial string matching, ex: name=foo
      --no-header           hide table header from output
      --no-truncate         do not truncate output to fit screen
      --output=<option>     output in a more machine friendly format
                            <options: csv|json|yaml>
      --sort=<value>        property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List schedules.

EXAMPLES
  $ apimetrics schedules
  Name          Frequency        Regions
  ───────────── ──────────────── ───────
  High freq     Every 10 seconds all
  Schedule 2    Every 5 minutes  all, oc

See code: src/commands/schedules/index.ts

apimetrics schedules calls

List calls on the schedule.

USAGE
  $ apimetrics schedules calls -s <value> [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv
    | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-p <value>]

FLAGS
  -p, --project-id=<value>   ID of project to read. Overrides apimetrics config project set. Can be found in the Project
                             Settings web page under the admin section or by using the command `apimetrics projects
                             --columns name,id`.
  -s, --schedule-id=<value>  (required) ID of schedule to modify. Can be found by using the command `apimetrics
                             schedules --columns name,id`.
  -x, --extended             show extra columns
      --columns=<value>      only show provided columns (comma-separated)
      --csv                  output is csv format [alias: --output=csv]
      --filter=<value>       filter property by partial string matching, ex: name=foo
      --no-header            hide table header from output
      --no-truncate          do not truncate output to fit screen
      --output=<option>      output in a more machine friendly format
                             <options: csv|json|yaml>
      --sort=<value>         property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List calls on the schedule.

EXAMPLES
  $ apimetrics schedules calls --schedule-id ag9zfmFwaW1ldHJpY3MtcWNyFQsSCFNjaGVkdWxlGICA4Pbn4ZILDA
  Name   Description Method URL
  ────── ─────────── ────── ──────────────────────────
  Apples             GET    https://example.com/apples

See code: src/commands/schedules/calls/index.ts

apimetrics schedules calls add

Add an API call to a Schedule.

USAGE
  $ apimetrics schedules calls add -c <value> -s <value> [--json]

FLAGS
  -c, --call-id=<value>      (required) ID of call to add. Can be found in the expanded Audit Logs of the desired API
                             call in the Audit tab web page or by using the command `apimetrics calls --columns
                             name,id`.
  -s, --schedule-id=<value>  (required) ID of schedule to modify. Can be found by using the command `apimetrics
                             schedules --columns name,id`.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Add an API call to a Schedule.

ALIASES
  $ apimetrics calls schedules add

EXAMPLES
  $ apimetrics schedules calls add --schedule-id ag9zfmFwaW1ldHJpY3MtcWNyFQsSCFNjaGVkdWxlGICA4Pbn4ZILDA --call-id ag9zfmFwaW1ldHJpY3MtcWNyFwsSClRlc3RTZXR1cDIYgIDg9f3DuAoM

See code: src/commands/schedules/calls/add.ts

apimetrics schedules calls remove

Remove call from schedule

USAGE
  $ apimetrics schedules calls remove -c <value> -s <value> [--json]

FLAGS
  -c, --call-id=<value>      (required) ID of call to remove. Can be found in the expanded Audit Logs of the desired API
                             call in the Audit tab web page or by using the command `apimetrics calls --columns
                             name,id`.
  -s, --schedule-id=<value>  (required) ID of schedule to modify. Can be found by using the command `apimetrics
                             schedules --columns name,id`.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Remove call from schedule

ALIASES
  $ apimetrics calls schedules delete

EXAMPLES
  $ apimetrics schedules calls remove --schedule-id ag9zfmFwaW1ldHJpY3MtcWNyFQsSCFNjaGVkdWxlGICA4Pbn4ZILDA --call-id ag9zfmFwaW1ldHJpY3MtcWNyFwsSClRlc3RTZXRjklafJhslw62dahoM

See code: src/commands/schedules/calls/remove.ts

apimetrics schedules create

Create a new Schedule for the Project.

USAGE
  $ apimetrics schedules create --interval 1m|2m|3m|4m|5m|6m|10m|12m|15m|20m|30m|60m|2h|3h|4h|6h|8h|12h|24h --name
    <value> [--json] [--ignore-in-stats <value>] [--location <value>] [--max-retries <value>] [--postman] [-p <value>]
    [--region <value>] [--retry-base <value>] [--retry-factor <value>] [--retry-interval <value>] [--retry-method
    fibonacci|exponential|constant] [--skip-notifications <value>]

FLAGS
  -p, --project-id=<value>          ID of project to modify. Overrides apimetrics config project set. Can be found in
                                    the Project Settings web page under the admin section or by using the command
                                    `apimetrics projects --columns name,id`.
      --ignore-in-stats=<value>     Number of retries to ignore in failure statistics.
      --interval=<option>           (required) Schedule interval.
                                    <options: 1m|2m|3m|4m|5m|6m|10m|12m|15m|20m|30m|60m|2h|3h|4h|6h|8h|12h|24h>
      --location=<value>...         Location to run calls from.
      --max-retries=<value>         Maximum number of retries to attempt.
      --name=<value>                (required) Name of schedule.
      --postman                     Only enable if you use the Postman Monitoring feature
      --region=<value>...           Region to run calls from.
      --retry-base=<value>          Base for exponential retry.
      --retry-factor=<value>        Factor for exponential retry.
      --retry-interval=<value>      Wait X seconds between each retry.
      --retry-method=<option>       Algorithm for retries.
                                    <options: fibonacci|exponential|constant>
      --skip-notifications=<value>  Number of retries to attempt before sending notifications.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a new Schedule for the Project.

EXAMPLES
  $ apimetrics schedules create --name "My Schedule" --interval 5m
  ag9zfmFwaW1ldHlpPbCtcWNyMwsSDUFjY29lpo95kAab4GUiIHpYSTQxY2JEajkzcWRFbE5GTEVajkuY85RT7jdteFdmDA

See code: src/commands/schedules/create.ts

apimetrics schedules delete

Delete a schedule.

USAGE
  $ apimetrics schedules delete --schedule-id <value> [--json]

FLAGS
  --schedule-id=<value>  (required) Schedule to delete. Can be found by using the command `apimetrics schedules
                         --columns name,id

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a schedule.

EXAMPLES
  $ apimetrics schedules delete --schedule-id ag9zfmFwaW1ldHlpPbCtcWNyMwsSDUFjY29lpo95kAab4GUiIHpYSTQxY2JEajkzcWRFbE5GTEVajkuY85RT7jdteFdmDA

See code: src/commands/schedules/delete.ts

apimetrics schedules downtimes

List downtimes for all Schedules.

USAGE
  $ apimetrics schedules downtimes [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-p <value>]

FLAGS
  -p, --project-id=<value>  ID of project to read. Overrides apimetrics config project set. Can be found in the Project
                            Settings web page under the admin section or by using the command `apimetrics projects
                            --columns name,id`.
  -x, --extended            show extra columns
      --columns=<value>     only show provided columns (comma-separated)
      --csv                 output is csv format [alias: --output=csv]
      --filter=<value>      filter property by partial string matching, ex: name=foo
      --no-header           hide table header from output
      --no-truncate         do not truncate output to fit screen
      --output=<option>     output in a more machine friendly format
                            <options: csv|json|yaml>
      --sort=<value>        property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List downtimes for all Schedules.

EXAMPLES
  $ apimetrics schedules downtimes
  ID           Schedule ID  Start                       End                         Repeat
  ──────────── ──────────── ─────────────────────────── ─────────────────────────── ──────
  ag9zfmFwaW1… ag9zfmFwaW1… 2023-09-29T14:54:41.865000Z 2023-09-30T14:54:41.865000Z never
  ag9zfmFwaW1… ag9zfmFwaW1… 2023-09-29T14:57:39.134000Z 2023-10-20T14:57:39.134000Z daily

See code: src/commands/schedules/downtimes/index.ts

apimetrics schedules downtimes create

Create downtime for a Schedule.

USAGE
  $ apimetrics schedules downtimes create --end <value> --schedule-id <value> --start <value> [--json] [--repeat
  daily|weekly]

FLAGS
  --end=<value>          (required) Date and time to end downtime in Date Time format (YYYY-MM-DDTHH:mm:ss.sssZ).
  --repeat=<option>      Repeat this downtime at the set interval.
                         <options: daily|weekly>
  --schedule-id=<value>  (required) Schedule to modify. Can be found by using the command `apimetrics schedules
                         --columns name,id
  --start=<value>        (required) Date and time to start downtime in Date Time format (YYYY-MM-DDTHH:mm:ss.sssZ).

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create downtime for a Schedule.

EXAMPLES
  $ apimetrics schedules downtimes create --schedule-id pPbCtcWNyMwsSDU --start 2023-07-21T18:32:00Z --end 2023-07-21T19:32:00Z
  ag9zfmFwaW1ldHlpPbCtcWNyMwsSDUFjY29lpo95kAab4GUiIHpYSTQxY2JEajkzcWRFbE5GTEVajkuY85RT7jdteFdmDA

See code: src/commands/schedules/downtimes/create.ts

apimetrics schedules downtimes delete

Delete a downtime for a Schedule.

USAGE
  $ apimetrics schedules downtimes delete --downtime-id <value> [--json] [-p <value>]

FLAGS
  -p, --project-id=<value>   ID of project to modify. Overrides apimetrics config project set. Can be found in the
                             Project Settings web page under the admin section or by using the command `apimetrics
                             projects --columns name,id`.
      --downtime-id=<value>  (required) Downtime to delete. Can be found using the command`apimetrics schedules
                             downtimes --columns id

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a downtime for a Schedule.

EXAMPLES
  $ apimetrics schedules downtimes delete --downtime-id ag9zfmFwaW1ldHlpPbCtcWNyMwsSDUFjY29lpo95kAab4GUiIHpYSTQxY2JEajkzcWRFbE5GTEVajkuY85RT7jdteFdmDA

See code: src/commands/schedules/downtimes/delete.ts

apimetrics schedules downtimes edit

Edit downtime.

USAGE
  $ apimetrics schedules downtimes edit --downtime-id <value> [--json] [--end <value>] [--repeat daily|weekly|off] [--start
    <value>]

FLAGS
  --downtime-id=<value>  (required) Downtime to edit. Can be found using the command`apimetrics schedules downtimes
                         --columns id
  --end=<value>          Date and time to end downtime in Date Time format (YYYY-MM-DDTHH:mm:ss.sssZ).
  --repeat=<option>      Repeat this downtime at the set interval.
                         <options: daily|weekly|off>
  --start=<value>        Date and time to start downtime in Date Time format (YYYY-MM-DDTHH:mm:ss.sssZ).

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Edit downtime.

EXAMPLES
  $ apimetrics schedules downtimes edit --downtime-id pPbCtcWNyMwsSDU --start 2023-07-21T18:32:00Z --end 2023-07-21T19:32:00Z

See code: src/commands/schedules/downtimes/edit.ts

apimetrics schedules edit

Edit an existing Schedule.

USAGE
  $ apimetrics schedules edit --schedule-id <value> [--json] [--add-location <value>] [--add-region <value>]
    [--ignore-in-stats <value>] [--interval 1m|2m|3m|4m|5m|6m|10m|12m|15m|20m|30m|60m|2h|3h|4h|6h|8h|12h|24h]
    [--max-retries <value>] [--name <value>] [--no-postman] [--postman] [--remove-location <value>] [--remove-region
    <value>] [--retry] [--retry-base <value>] [--retry-factor <value>] [--retry-interval <value>] [--retry-method
    fibonacci|exponential|constant] [--skip-notifications <value>]

FLAGS
  --add-location=<value>...     Add location to run calls from.
  --add-region=<value>...       Add region to run calls from.
  --ignore-in-stats=<value>     Number of retries to ignore in failure statistics.
  --interval=<option>           Schedule interval.
                                <options: 1m|2m|3m|4m|5m|6m|10m|12m|15m|20m|30m|60m|2h|3h|4h|6h|8h|12h|24h>
  --max-retries=<value>         Maximum number of retries to attempt.
  --name=<value>                Name of schedule.
  --no-postman                  Disable the Postman Monitoring feature
  --postman                     Only enable if you use the Postman Monitoring feature
  --remove-location=<value>...  Remove location to run calls from.
  --remove-region=<value>...    Remove region to run calls from.
  --[no-]retry                  Should retry be enabled?
  --retry-base=<value>          Base for exponential retry.
  --retry-factor=<value>        Factor for exponential retry.
  --retry-interval=<value>      Wait X seconds between each retry.
  --retry-method=<option>       Algorithm for retries.
                                <options: fibonacci|exponential|constant>
  --schedule-id=<value>         (required) Schedule to modify. Can be found by using the command `apimetrics schedules
                                --columns name,id
  --skip-notifications=<value>  Number of retries to attempt before sending notifications.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Edit an existing Schedule.

EXAMPLES
  $ apimetrics schedules edit --name "My Schedule" --interval 5m
  ag9zfmFwaW1ldHlpPbCtcWNyMwsSDUFjY29lpo95kAab4GUiIHpYSTQxY2JEajkzcWRFbE5GTEVajkuY85RT7jdteFdmDA

See code: src/commands/schedules/edit.ts