> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> API reference for Updown.io: every `updownio.api.*` operation with input and output types.

Every `updownio.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

<Info>
  **New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
</Info>

## Checks

### list

`checks.list`

List all monitoring checks on the account

**Risk:** `read`

```ts theme={null}
await corsair.updownio.api.checks.list({});
```

**Input:** *empty object*

**Output:** `object[]`

<AccordionGroup>
  <Accordion title="Output full type">
    ```ts theme={null}
    {
      token: string,
      url?: string | null,
      type?: string | null,
      alias?: string | null,
      last_status?: number | null,
      uptime?: number | null,
      down?: boolean | null,
      down_since?: string | null,
      up_since?: string | null,
      error?: string | null,
      period?: number | null,
      apdex_t?: number | null,
      string_match?: string | null,
      enabled?: boolean | null,
      published?: boolean | null,
      disabled_locations?: string[] | null,
      recipients?: string[] | null,
      last_check_at?: string | null,
      next_check_at?: string | null,
      created_at?: string | null,
      mute_until?: string | null,
      favicon_url?: string | null,
      custom_headers?: Record<string, string> | null,
      http_verb?: string | null,
      http_body?: string | null,
      ssl?: {
        tested_at?: string | null,
        expires_at?: string | null,
        valid?: boolean | null,
        error?: string | null,
        cert?: {
          subject?: string | null,
          subject_org?: string | null,
          san?: string[] | null,
          issuer?: string | null,
          issuer_org?: string | null,
          from?: string | null,
          to?: string | null,
          algorithm?: string | null
        } | null
      } | null,
      domain?: {
        tested_at?: string | null,
        expires_at?: string | null,
        remaining_days?: number | null,
        source?: string | null
      } | null
    }[]
    ```
  </Accordion>
</AccordionGroup>

***

## Nodes

### list

`nodes.list`

List all Updown.io monitoring and webhook nodes

**Risk:** `read`

```ts theme={null}
await corsair.updownio.api.nodes.list({});
```

**Input:** *empty object*

**Output:** `Record<string, UpdownIONode>`

<AccordionGroup>
  <Accordion title="Output full type">
    ```ts theme={null}
    Record<string, {
      ip?: string | null,
      ip6?: string | null,
      city?: string | null,
      country?: string | null,
      country_code?: string | null,
      lat?: number | null,
      lng?: number | null
    }>
    ```
  </Accordion>
</AccordionGroup>

***

### listIps

`nodes.listIps`

List all Updown.io node IP addresses

**Risk:** `read`

```ts theme={null}
await corsair.updownio.api.nodes.listIps({});
```

**Input:** *empty object*

**Output:** `string[]`

***

### listIpv4

`nodes.listIpv4`

List all Updown.io node IPv4 addresses

**Risk:** `read`

```ts theme={null}
await corsair.updownio.api.nodes.listIpv4({});
```

**Input:** *empty object*

**Output:** `string[]`

***

### listIpv6

`nodes.listIpv6`

List all Updown.io node IPv6 addresses

**Risk:** `read`

```ts theme={null}
await corsair.updownio.api.nodes.listIpv6({});
```

**Input:** *empty object*

**Output:** `string[]`

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.