Class PSPs

constructor

• new PSPs(client: RequestClient): PSPs

  Creates a new PSPs client.

  Parameters

  • client: RequestClient

    The request client to use.

  Returns PSPs

Readonlyannouncements

create

• create(payload: PSPPayload): Promise<PSP>

  Creates a new public status page in your UptimeRobot account. The status page will be live immediately after creation.

  Parameters

  • payload: PSPPayload

    PSP configuration object (see PSPPayload interface for all options)

  Returns Promise<PSP>

  Promise that resolves to the created PSP object with assigned ID

  Throws

  When required fields are missing or validation fails

  Throws

  When conditional requirements are not met (e.g., provided image is wrong size)

  Throws

  When API request fails or returns an error response

  Example

  // Create a password-protected status page with two monitors
  const httpMonitor = await service.psps.create({
    friendlyName: 'My PSP',
    monitorIds: ['id-1', 'id-2'],
    logo: './images/logo.png',
    password: 'securepassword'
  });
  Copy

  See

  https://uptimerobot.com/api/v3/#post-/psps Official API Documentation

  Since

  1.0.0

delete

• delete(id: idField): Promise<boolean>

  Removes a public status page completely from your UptimeRobot account. This action cannot be undone. The status page URL will become inaccessible immediately.

  Parameters

  • id: idField

    PSP ID (number or string)

  Returns Promise<boolean>

  Promise that resolves to true when deletion is successful

  Throws

  When PSP ID is not found

  Throws

  When API request fails

  Example

  // Delete a status page
  const success = await service.psps.delete(12345);
  if (success) {
    console.log('Status page deleted successfully');
  }
  Copy

  See

  https://uptimerobot.com/api/v3/#delete-/psps/-id- Official API Documentation

  Since

  1.0.0

get

• get(id: idField): Promise<PSP>

  Fetches complete configuration and current information for an individual public status page by ID. Returns all PSP properties including friendly name, monitors, customization settings, and access details.

  Parameters

  • id: idField

    PSP ID (number or string)

  Returns Promise<PSP>

  Promise that resolves to the PSP object

  Throws

  When PSP ID is not found

  Throws

  When API request fails

  Example

  // Get PSP details
  const psp = await service.psps.get(12345);
  console.log(`Status page "${psp.friendlyName}" has ${psp.monitorIds.length} monitors`);
  Copy

  See

  https://uptimerobot.com/api/v3/#get-/psps/-id- Official API Documentation

  Since

  1.0.0

list

• list(options?: { cursor?: number }, returnFullResponse?: false): Promise<PSP[]>

  Retrieves a list of public status pages (PSPs) from your UptimeRobot account. Results are paginated using cursor-based pagination.

  Parameters

  • Optionaloptions: { cursor?: number }

    Query string parameters passed to the API

    • Optionalcursor?: number

      Pagination cursor for next page

  • OptionalreturnFullResponse: false

  Returns Promise<PSP[]>

  Returns PSP[] by default, or URFullResponse<PSP> if returnFullResponse is true.

  Throws

  When cursor is negative

  Example

  // Get status pages
  const psps = await service.psps.list();
  
  // Paginate through results
  const page1 = await service.psps.list();
  const page2 = await service.psps.list({ cursor: 123456789 });
  
  // Get full response for pagination
  const response = await service.psps.list({}, true);
  const nextUrl = new URL(response.nextLink);
  const nextCursorVal = nextUrl.searchParams.get('cursor');
  console.log(nextCursorVal);
  Copy

  See

  https://uptimerobot.com/api/v3/#get-/psps Official API Documentation

  Since

  1.0.0

• list(
      options: { cursor?: number },
      returnFullResponse: true,
  ): Promise<URFullResponse<PSP>>

  Retrieves a list of public status pages (PSPs) from your UptimeRobot account. Results are paginated using cursor-based pagination.

  Parameters

  • options: { cursor?: number }

    Query string parameters passed to the API

    • Optionalcursor?: number

      Pagination cursor for next page

  • returnFullResponse: true

  Returns Promise<URFullResponse<PSP>>

  Returns PSP[] by default, or URFullResponse<PSP> if returnFullResponse is true.

  Throws

  When cursor is negative

  Example

  // Get status pages
  const psps = await service.psps.list();
  
  // Paginate through results
  const page1 = await service.psps.list();
  const page2 = await service.psps.list({ cursor: 123456789 });
  
  // Get full response for pagination
  const response = await service.psps.list({}, true);
  const nextUrl = new URL(response.nextLink);
  const nextCursorVal = nextUrl.searchParams.get('cursor');
  console.log(nextCursorVal);
  Copy

  See

  https://uptimerobot.com/api/v3/#get-/psps Official API Documentation

  Since

  1.0.0

update

• update(id: idField, payload: PSPPayload): Promise<PSP>

  Modifies the settings of an existing public status page. Only provided fields will be updated; omitted fields retain their current values. Changes take effect immediately on the live status page.

  Parameters

  • id: idField

    PSP ID (number or string)

  • payload: PSPPayload

    PSP configuration updates (partial PSPPayload object)

  Returns Promise<PSP>

  Promise that resolves to the updated PSP object

  Throws

  When PSP ID is not found

  Throws

  When payload validation fails

  Throws

  When conditional requirements are not met (e.g., invalid image format)

  Example

  // Update status page name and add monitors
  const updatedPSP = await service.psps.update(12345, {
    friendlyName: 'Updated Status Page',
    monitorIds: ['monitor1', 'monitor2', 'monitor3']
  });
  
  // Update with new logo image
  const pspWithLogo = await service.psps.update(12345, {
    logo: './images/new-logo.png'
  });
  Copy

  See

  https://uptimerobot.com/api/v3/#post-/psps Official API Documentation

  Since

  1.0.0