Get a single nOps Essentials instance.

GET 
/svc/notifications/scheduler/nops_scheduler/:id

Get a single nOps Essentials instance.

Request

Path Parameters

id uuidrequired

A UUID string identifying nOps Essentials.

Responses

200

application/json

Schema

Schema

id uuidrequired
client integerrequired
project integer

Possible values: >= -2147483648 and <= 2147483647

user integerrequired
name stringrequired

Possible values: <= 250 characters

account_number stringrequired

Possible values: <= 50 characters

resources

object[]

Array [

id integerrequired

created date-timerequired

modified date-timerequired

item_type ItemTypeEnum (string)required

Possible values: [ec2, rds, rds_cluster, autoscaling_groups, eks_nodegroup, ebs, snapshot]

item_id stringnullable

Possible values: <= 255 characters

resource_id stringnullable

Possible values: <= 2048 characters

resource_name stringnullable

Possible values: <= 2048 characters

resource_arn stringnullable

Possible values: <= 2048 characters

state SchedulerResourceStateEnum (string)

Possible values: [active, deleted]

status

object

nullable

oneOf

StatusEnum

string

Possible values: [running, stopped, terminated, not_determined]

last_check_status date-timenullable

region stringnullable

Possible values: <= 50 characters

resource_details

object

property name* any

price_per_unit floatnullable

manually_added boolean

scheduler uuidrequired

]

actions

object[]

required

Array [

id integer

position stringrequired

created date-timerequired

modified date-timerequired

action ActionEnum (string)required

Possible values: [start, stop, terminate, modify, update_ec2_auto_scaling, ebs_migration, ec2_rightsizing, delete_volume, delete_volume_with_snapshot, archive_snapshot]

action_details

object

property name* any

action_type ActionTypeEnum (string)

Possible values: [selected_day_of_week, cronjob, onetime]

day_of_week DayOfWeekEnum (string)[]nullable

Possible values: [mon, tue, wed, thu, fri, sat, sun]

hour integernullable

Possible values: <= 23

minute integernullable

Possible values: <= 59

state StateB9aEnum (string)

Possible values: [active, inactive, deleting]

last_run date-timenullable

last_manual_trigger date-timenullable

run_date date-timenullable

scheduler uuidrequired

]

state StateB9aEnum (string)required

Possible values: [active, inactive, deleting]

eventbridge_configuration uuidnullable
scheduler_for SchedulerForEnum (string)

Possible values: [scheduler_start_stop, ec2_auto_scaling, nswitch_essential, nswitch_changeset, essentials_idle_resources, essentials__scheduler, essentials__storage, essentials__rightsizing, essentials__idle_resources]

description string

Possible values: <= 255 characters

recommendation_hash string

Possible values: <= 255 characters

hours_down floatnullable
scheduled_by_tag_key string

Possible values: <= 64 characters

scheduled_by_tag_value string

Possible values: <= 64 characters

changeset_pull_request_urls string[]

Possible values: <= 255 characters

pull_requests

object[]

Array [

project_id int64required

Possible values: >= -9223372036854776000 and <= 9223372036854776000

gitsource_pull_request_id int64required

Possible values: >= -9223372036854776000 and <= 9223372036854776000

project_pull_request_id integerrequired

Possible values: >= -2147483648 and <= 2147483647

labels string[]

Possible values: <= 255 characters

source_branch stringrequired

Possible values: <= 256 characters

target_branch stringrequired

Possible values: <= 256 characters

web_url stringrequired

Possible values: <= 2048 characters

project_name string

Possible values: <= 256 characters

created_at date-timerequired

merged_at date-timenullable

closed_at date-timenullable

state ChangesetPullRequestStateEnum (string)

Possible values: [opened, merged, closed, locked]

git_source GitSourceEnum (string)required

Possible values: [github, gitlab]

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "client": 0,
  "project": 0,
  "user": 0,
  "name": "string",
  "account_number": "string",
  "resources": [
    {
      "id": 0,
      "created": "2024-07-29T15:51:28.071Z",
      "modified": "2024-07-29T15:51:28.071Z",
      "item_type": "ec2",
      "item_id": "string",
      "resource_id": "string",
      "resource_name": "string",
      "resource_arn": "string",
      "state": "active",
      "status": "running",
      "last_check_status": "2024-07-29T15:51:28.071Z",
      "region": "string",
      "resource_details": {},
      "price_per_unit": 0,
      "manually_added": true,
      "scheduler": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "actions": [
    {
      "id": 0,
      "position": "string",
      "created": "2024-07-29T15:51:28.071Z",
      "modified": "2024-07-29T15:51:28.071Z",
      "action": "start",
      "action_details": {},
      "action_type": "selected_day_of_week",
      "day_of_week": [
        "mon"
      ],
      "hour": 0,
      "minute": 0,
      "state": "active",
      "last_run": "2024-07-29T15:51:28.071Z",
      "last_manual_trigger": "2024-07-29T15:51:28.071Z",
      "run_date": "2024-07-29T15:51:28.071Z",
      "scheduler": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "state": "active",
  "eventbridge_configuration": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "scheduler_for": "scheduler_start_stop",
  "description": "string",
  "recommendation_hash": "string",
  "hours_down": 0,
  "scheduled_by_tag_key": "string",
  "scheduled_by_tag_value": "string",
  "changeset_pull_request_urls": [
    "string"
  ],
  "pull_requests": [
    {
      "project_id": 0,
      "gitsource_pull_request_id": 0,
      "project_pull_request_id": 0,
      "labels": [
        "string"
      ],
      "source_branch": "string",
      "target_branch": "string",
      "web_url": "string",
      "project_name": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "merged_at": "2024-07-29T15:51:28.071Z",
      "closed_at": "2024-07-29T15:51:28.071Z",
      "state": "opened",
      "git_source": "github"
    }
  ]
}

Loading...