--- title: "Update component" method: PATCH path: "/api/v2/statuspages/{page_id}/components/{component_id}" tags: ["Status Pages"] --- # Update component `PATCH /api/v2/statuspages/{page_id}/components/{component_id}` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}` - Auth: one of: - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` - OAuth 2 - Authorization code: `/oauth2/v1/authorize` - Token URL: `/oauth2/v1/token` scopes: `status_pages_settings_write` Updates an existing component's attributes. ## Path parameters - `page_id` string, uuid, required - `component_id` string, uuid, required ## Query parameters - `include` string ## Request body - PatchComponentRequest: Request object for updating a component. - `data` PatchComponentRequestData: The data object for updating a component. - `attributes` PatchComponentRequestDataAttributes, required: The supported attributes for updating a component. - `name` string: The name of the component. - `position` integer: The position of the component. If the component belongs to a group, the position is relative to the other components in the group. - `id` string, uuid, required: The ID of the component. - `type` 'components', required: Components resource type. ## Response `200` OK - StatusPagesComponent: Response object for a single component. - `data` StatusPagesComponentData: The data object for a component. - `attributes` StatusPagesComponentDataAttributes: The attributes of a component. - `components` StatusPagesComponentDataAttributesComponentsItems[]: If the component is of type `group`, the components within the group. - `id` string, uuid: The ID of the component within the group. - `name` string: The name of the component within the group. - `position` integer: The zero-indexed position of the component within the group. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component. - `type` 'component': The type of the component. - `created_at` string, date-time: Timestamp of when the component was created. - `modified_at` string, date-time: Timestamp of when the component was last modified. - `name` string: The name of the component. - `position` integer: The zero-indexed position of the component. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component. - `type` 'component' | 'group', required: The type of the component. - `id` string, uuid: The ID of the component. - `relationships` StatusPagesComponentDataRelationships: The relationships of a component. - `created_by_user` StatusPagesComponentDataRelationshipsCreatedByUser: The Datadog user who created the component. - `data` StatusPagesComponentDataRelationshipsCreatedByUserData, required: The data object identifying the Datadog user who created the component. - `id` string, required: The ID of the Datadog user who created the component. - `type` 'users', required: Users resource type. - `group` StatusPagesComponentDataRelationshipsGroup: The group the component belongs to. - `data` StatusPagesComponentDataRelationshipsGroupData, nullable, required: The data object identifying the group the component belongs to. - `id` string, uuid, required: The ID of the group the component belongs to. - `type` 'components', required: Components resource type. - `last_modified_by_user` StatusPagesComponentDataRelationshipsLastModifiedByUser: The Datadog user who last modified the component. - `data` StatusPagesComponentDataRelationshipsLastModifiedByUserData, required: The data object identifying the Datadog user who last modified the component. - `id` string, required: The ID of the Datadog user who last modified the component. - `type` 'users', required: Users resource type. - `status_page` StatusPagesComponentDataRelationshipsStatusPage: The status page the component belongs to. - `data` StatusPagesComponentDataRelationshipsStatusPageData, required: The data object identifying the status page the component belongs to. - `id` string, uuid, required: The ID of the status page the component belongs to. - `type` 'status_pages', required: Status pages resource type. - `type` 'components', required: Components resource type. - `included` StatusPagesComponentArrayIncluded[]: The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter. - union: An included resource related to a component. - StatusPagesUser: The included Datadog user resource. - `attributes` StatusPagesUserAttributes: Attributes of the Datadog user. - `email` string: The email of the Datadog user. - `handle` string: The handle of the Datadog user. - `icon` string: The icon of the Datadog user. - `name` string: The name of the Datadog user. - `uuid` string: The UUID of the Datadog user. - `id` string, uuid: The ID of the Datadog user. - `type` 'users', required: Users resource type. - StatusPageAsIncluded: The included status page resource. - `attributes` StatusPageAsIncludedAttributes: The attributes of a status page. - `company_logo` string: The base64-encoded image data displayed in the company logo. - `components` StatusPageAsIncludedAttributesComponentsItems[]: Components displayed on the status page. - `components` StatusPageAsIncludedAttributesComponentsItemsComponentsItems[]: If the component is of type `group`, the components within the group. - … - `id` string, uuid: The ID of the component. - `name` string: The name of the component. - `position` integer: The zero-indexed position of the component. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component. - `type` 'component' | 'group': The type of the component. - `created_at` string, date-time: Timestamp of when the status page was created. - `custom_domain` string: If configured, the url that the status page is accessible at. - `custom_domain_enabled` boolean: Whether the custom domain is configured. - `domain_prefix` string: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. - `email_header_image` string: Base64-encoded image data included in email notifications sent to status page subscribers. - `enabled` boolean: Whether the status page is enabled. - `favicon` string: Base64-encoded image data displayed in the browser tab. - `modified_at` string, date-time: Timestamp of when the status page was last modified. - `name` string: The name of the status page. - `page_url` string: The url that the status page is accessible at. - `slack_app_icon` string: The Slack app icon URL for the status page. - `slack_subscriptions_enabled` boolean: Whether Slack subscriptions are enabled for the status page. - `subscriptions_enabled` boolean: Whether users can subscribe to the status page. - `type` 'public' | 'internal': The type of the status page controlling how the status page is accessed. - `visualization_type` 'bars_and_uptime_percentage' | 'bars_only' | 'component_name_only': The visualization type of the status page. - `id` string, uuid: The ID of the status page. - `relationships` StatusPageAsIncludedRelationships: The relationships of a status page. - `created_by_user` StatusPageAsIncludedRelationshipsCreatedByUser: The Datadog user who created the status page. - `data` StatusPageAsIncludedRelationshipsCreatedByUserData, required: The data object identifying the Datadog user who created the status page. - … - `last_modified_by_user` StatusPageAsIncludedRelationshipsLastModifiedByUser: The Datadog user who last modified the status page. - `data` StatusPageAsIncludedRelationshipsLastModifiedByUserData, required: The data object identifying the Datadog user who last modified the status page. - … - `type` 'status_pages', required: Status pages resource type. - StatusPagesComponentGroup: The included component group resource. - `attributes` StatusPagesComponentGroupAttributes: The attributes of a component group. - `components` StatusPagesComponentGroupAttributesComponentsItems[]: If the component is of type `group`, the components within the group. - `id` string, uuid: The ID of the grouped component. - `name` string: The name of the grouped component. - `position` integer: The zero-indexed position of the grouped component. Relative to the other components in the group. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component. - `type` 'component': The type of the component. - `created_at` string, date-time: Timestamp of when the component was created. - `modified_at` string, date-time: Timestamp of when the component was last modified. - `name` string: The name of the component. - `position` integer: The zero-indexed position of the component. - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component. - `type` 'component' | 'group', required: The type of the component. - `id` string, uuid: The ID of the component. - `relationships` StatusPagesComponentGroupRelationships: The relationships of a component group. - `created_by_user` StatusPagesComponentGroupRelationshipsCreatedByUser: The Datadog user who created the component group. - `data` StatusPagesComponentGroupRelationshipsCreatedByUserData, required: The data object identifying the Datadog user who created the component group. - … - `group` StatusPagesComponentGroupRelationshipsGroup: The group the component group belongs to. - `data` StatusPagesComponentGroupRelationshipsGroupData, nullable, required: The data object identifying the parent group of a component group. - … - `last_modified_by_user` StatusPagesComponentGroupRelationshipsLastModifiedByUser: The Datadog user who last modified the component group. - `data` StatusPagesComponentGroupRelationshipsLastModifiedByUserData, required: The data object identifying the Datadog user who last modified the component group. - … - `status_page` StatusPagesComponentGroupRelationshipsStatusPage: The status page the component group belongs to. - `data` StatusPagesComponentGroupRelationshipsStatusPageData, required: The data object identifying the status page the component group belongs to. - … - `type` 'components', required: Components resource type. ## Other responses - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)