# StatusPages

## Overview

### Available Operations

* [list](#list) - List Status Pages
* [create](#create) - Create Status Page
* [delete\_by\_id](#delete_by_id) - Delete Status Page By ID
* [get\_by\_id](#get_by_id) - Get Status Page By ID
* [update](#update) - Update Status Page By ID
* [list\_statuses](#list_statuses) - List Status Page Statuses

## list

List Status Pages

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.list(page_size=301790, page_number=172386, filters_is_public="<value>", team_id="<id>")

    while res is not None:
        # Handle items

        res = res.next()

```

### Parameters

| Parameter           | Type                                                                          | Required             | Description                                                         |
| ------------------- | ----------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `page_size`         | *int*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `page_number`       | *int*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `filters_is_public` | *str*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `team_id`           | *str*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `retries`           | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesListStatusPagesResponse**](/python-sdk/docs/models/statuspagesliststatuspagesresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## create

Create Status Page

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.create(name="<value>", domain_name="failing-convection.com", logo_url="https://snarling-season.info", timezone="Pacific/Chuuk", team_id="<id>", contact_email="<value>", owner_type="team", owner_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter                        | Type                                                                                                                             | Required             | Description                                                         |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `name`                           | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `domain_name`                    | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `logo_url`                       | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `timezone`                       | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `team_id`                        | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `contact_email`                  | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `owner_type`                     | [models.V4StatusPagesCreateStatusPageRequestOwnerType](/python-sdk/docs/models/v4statuspagescreatestatuspagerequestownertype.md) | :heavy\_check\_mark: | N/A                                                                 |
| `owner_id`                       | *str*                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `description`                    | *Optional\[str]*                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `is_public`                      | *Optional\[bool]*                                                                                                                | :heavy\_minus\_sign: | N/A                                                                 |
| `custom_domain_name`             | *Optional\[str]*                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `theme_color`                    | [Optional\[models.V4StatusPagesNewStatusPageThemeColor\]](/python-sdk/docs/models/v4statuspagesnewstatuspagethemecolor.md)       | :heavy\_minus\_sign: | N/A                                                                 |
| `components`                     | List\[[models.V4StatusPagesNewStatusPageComponentList](/python-sdk/docs/models/v4statuspagesnewstatuspagecomponentlist.md)]      | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_webhook_subscription`     | *Optional\[bool]*                                                                                                                | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_components_subscription`  | *Optional\[bool]*                                                                                                                | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_maintenance_subscription` | *Optional\[bool]*                                                                                                                | :heavy\_minus\_sign: | N/A                                                                 |
| `retries`                        | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md)                                                    | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesCreateStatusPageResponse**](/python-sdk/docs/models/statuspagescreatestatuspageresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## delete\_by\_id

Delete Status Page By ID

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.delete_by_id(statuspage_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter       | Type                                                                          | Required             | Description                                                         |
| --------------- | ----------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `statuspage_id` | *str*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `retries`       | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesDeleteStatusPageByIDResponse**](/python-sdk/docs/models/statuspagesdeletestatuspagebyidresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## get\_by\_id

Get Status Page By ID

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.get_by_id(statuspage_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter       | Type                                                                          | Required             | Description                                                         |
| --------------- | ----------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `statuspage_id` | *str*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `retries`       | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesGetStatusPageByIDResponse**](/python-sdk/docs/models/statuspagesgetstatuspagebyidresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## update

Update Status Page By ID

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.update(statuspage_id="<id>", name="<value>", is_public=False, domain_name="blank-brief.info", team_id="<id>", theme_color={
        "primary": "<value>",
        "secondary": "<value>",
    }, contact_email="<value>", owner_type="<value>", owner_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter                        | Type                                                                                                                                              | Required             | Description                                                         |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `statuspage_id`                  | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `name`                           | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `is_public`                      | *bool*                                                                                                                                            | :heavy\_check\_mark: | N/A                                                                 |
| `domain_name`                    | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `team_id`                        | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `theme_color`                    | [models.V4StatusPagesUpdateStatusPageByIDRequestThemeColor](/python-sdk/docs/models/v4statuspagesupdatestatuspagebyidrequestthemecolor.md)        | :heavy\_check\_mark: | N/A                                                                 |
| `contact_email`                  | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `owner_type`                     | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `owner_id`                       | *str*                                                                                                                                             | :heavy\_check\_mark: | N/A                                                                 |
| `description`                    | *Optional\[str]*                                                                                                                                  | :heavy\_minus\_sign: | N/A                                                                 |
| `custom_domain_name`             | *Optional\[str]*                                                                                                                                  | :heavy\_minus\_sign: | N/A                                                                 |
| `logo_url`                       | *Optional\[str]*                                                                                                                                  | :heavy\_minus\_sign: | N/A                                                                 |
| `timezone`                       | *Optional\[str]*                                                                                                                                  | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_components_subscription`  | *Optional\[bool]*                                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_maintenance_subscription` | *Optional\[bool]*                                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `allow_webhook_subscription`     | *Optional\[bool]*                                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `components`                     | List\[[models.V4StatusPagesUpdateStatusPageByIDRequestComponent2](/python-sdk/docs/models/v4statuspagesupdatestatuspagebyidrequestcomponent2.md)] | :heavy\_minus\_sign: | N/A                                                                 |
| `is_custom_domain_enabled`       | *Optional\[bool]*                                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `hide_from_search_engines`       | *Optional\[bool]*                                                                                                                                 | :heavy\_minus\_sign: | N/A                                                                 |
| `retries`                        | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md)                                                                     | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesUpdateStatusPageByIDResponse**](/python-sdk/docs/models/statuspagesupdatestatuspagebyidresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## list\_statuses

List Status Page Statuses

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.status_pages.list_statuses(statuspage_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter       | Type                                                                          | Required             | Description                                                         |
| --------------- | ----------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `statuspage_id` | *str*                                                                         | :heavy\_check\_mark: | N/A                                                                 |
| `retries`       | [Optional\[utils.RetryConfig\]](/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.StatusPagesListStatusPageStatusesResponse**](/python-sdk/docs/models/statuspagesliststatuspagestatusesresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/sdks/statuspagessdk1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.