diff --git a/docs/godaddy-docs/index.md b/docs/godaddy-docs/index.md index 5e33031211..ec9e112f4c 100644 --- a/docs/godaddy-docs/index.md +++ b/docs/godaddy-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png id: godaddy-doc slug: /providers/godaddy - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Domain registration and web hosting services. :::info Provider Summary (v23.12.00190) @@ -49,7 +51,7 @@ REGISTRY PULL godaddy; The following system environment variables are used for authentication by default: -- `GODADDY_API_KEY` - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) +- - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/godaddy-docs/providers/godaddy/abuse/index.md b/docs/godaddy-docs/providers/godaddy/abuse/index.md index 36f9a1e13a..5cb0e30503 100644 --- a/docs/godaddy-docs/providers/godaddy/abuse/index.md +++ b/docs/godaddy-docs/providers/godaddy/abuse/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/abuse/tickets/index.md b/docs/godaddy-docs/providers/godaddy/abuse/tickets/index.md index 691a28eaa8..d213e92d46 100644 --- a/docs/godaddy-docs/providers/godaddy/abuse/tickets/index.md +++ b/docs/godaddy-docs/providers/godaddy/abuse/tickets/index.md @@ -14,32 +14,35 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametickets
TypeResource
Idgodaddy.abuse.tickets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `closed` | `boolean` | Is this abuse ticket closed? | -| `closedAt` | `string` | The date the abuse ticket was closed | -| `createdAt` | `string` | The date the abuse ticket was created | -| `domainIp` | `string` | The domain or IP the suspected abuse was reported against | -| `reporter` | `string` | The shopper id of the person who reported the suspected abuse | -| `source` | `string` | The single URL or IP the suspected abuse was reported against | -| `target` | `string` | The company the suspected abuse is targeting | -| `ticketId` | `string` | Abuse ticket ID | -| `type` | `string` | The type of abuse being reported | +| | `boolean` | Is this abuse ticket closed? | +| | `string` | The date the abuse ticket was closed | +| | `string` | The date the abuse ticket was created | +| | `string` | The domain or IP the suspected abuse was reported against | +| | `string` | The shopper id of the person who reported the suspected abuse | +| | `string` | The single URL or IP the suspected abuse was reported against | +| | `string` | The company the suspected abuse is targeting | +| | `string` | Abuse ticket ID | +| | `string` | The type of abuse being reported | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_ticket_info` | `SELECT` | `ticket_id` | Return the abuse ticket data for a given ticket id | -| `get_tickets` | `SELECT` | | List all abuse tickets ids that match user provided filters | -| `create_ticket` | `INSERT` | | Create a new abuse ticket | -| `_get_tickets` | `EXEC` | | List all abuse tickets ids that match user provided filters | +| | `SELECT` | | Return the abuse ticket data for a given ticket id | +| | `SELECT` | | List all abuse tickets ids that match user provided filters | +| | `INSERT` | | Create a new abuse ticket | +| | `EXEC` | | List all abuse tickets ids that match user provided filters | diff --git a/docs/godaddy-docs/providers/godaddy/aftermarket/index.md b/docs/godaddy-docs/providers/godaddy/aftermarket/index.md index bf5a1abc30..4baa0c859a 100644 --- a/docs/godaddy-docs/providers/godaddy/aftermarket/index.md +++ b/docs/godaddy-docs/providers/godaddy/aftermarket/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/aftermarket/listings/index.md b/docs/godaddy-docs/providers/godaddy/aftermarket/listings/index.md index 7d03af05c4..b42a9379bc 100644 --- a/docs/godaddy-docs/providers/godaddy/aftermarket/listings/index.md +++ b/docs/godaddy-docs/providers/godaddy/aftermarket/listings/index.md @@ -14,14 +14,17 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelistings
TypeResource
Idgodaddy.aftermarket.listings
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `delete_listings` | `DELETE` | `domains` | Remove listings from GoDaddy Auction | -| `add_expiry_listings` | `EXEC` | | Add expiry listings into GoDaddy Auction | +| | `DELETE` | | Remove listings from GoDaddy Auction | +| | `EXEC` | | Add expiry listings into GoDaddy Auction | diff --git a/docs/godaddy-docs/providers/godaddy/agreements/agreements/index.md b/docs/godaddy-docs/providers/godaddy/agreements/agreements/index.md index af77940ca5..ca8e2188bc 100644 --- a/docs/godaddy-docs/providers/godaddy/agreements/agreements/index.md +++ b/docs/godaddy-docs/providers/godaddy/agreements/agreements/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameagreements
TypeResource
Idgodaddy.agreements.agreements
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `agreementKey` | `string` | Unique identifier for the legal agreement | -| `content` | `string` | Contents of the legal agreement, suitable for embedding | -| `title` | `string` | Title of the legal agreement | -| `url` | `string` | URL to a page containing the legal agreement | +| | `string` | Unique identifier for the legal agreement | +| | `string` | Contents of the legal agreement, suitable for embedding | +| | `string` | Title of the legal agreement | +| | `string` | URL to a page containing the legal agreement | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `keys` | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/agreements/index.md b/docs/godaddy-docs/providers/godaddy/agreements/index.md index 6de4df2edd..c5644d1521 100644 --- a/docs/godaddy-docs/providers/godaddy/agreements/index.md +++ b/docs/godaddy-docs/providers/godaddy/agreements/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/certificates/actions/index.md b/docs/godaddy-docs/providers/godaddy/certificates/actions/index.md index 0b0ae7ce59..663d0a53d4 100644 --- a/docs/godaddy-docs/providers/godaddy/certificates/actions/index.md +++ b/docs/godaddy-docs/providers/godaddy/certificates/actions/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Idgodaddy.certificates.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `createdAt` | `string` | Date action created | -| `type` | `string` | | +| | `string` | Date action created | +| | `string` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `certificate_action_retrieve` | `SELECT` | `certificate_id` | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/certificates/callback/index.md b/docs/godaddy-docs/providers/godaddy/certificates/callback/index.md index 9df6285fb6..eec86e33ed 100644 --- a/docs/godaddy-docs/providers/godaddy/certificates/callback/index.md +++ b/docs/godaddy-docs/providers/godaddy/certificates/callback/index.md @@ -14,20 +14,23 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecallback
TypeResource
Idgodaddy.certificates.callback
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `certificate_callback_get` | `SELECT` | `certificate_id` | This method is used to retrieve the registered callback url for a certificate. | -| `certificate_callback_delete` | `DELETE` | `certificate_id` | Unregister the callback for a particular certificate. | -| `certificate_callback_replace` | `EXEC` | `callbackUrl, certificate_id` | This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration. | +| | `SELECT` | | This method is used to retrieve the registered callback url for a certificate. | +| | `DELETE` | | Unregister the callback for a particular certificate. | +| | `EXEC` | | This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration. | diff --git a/docs/godaddy-docs/providers/godaddy/certificates/certificates/index.md b/docs/godaddy-docs/providers/godaddy/certificates/certificates/index.md index 54c762472d..74778066db 100644 --- a/docs/godaddy-docs/providers/godaddy/certificates/certificates/index.md +++ b/docs/godaddy-docs/providers/godaddy/certificates/certificates/index.md @@ -14,46 +14,49 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecertificates
TypeResource
Idgodaddy.certificates.certificates
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `certificateId` | `string` | The unique identifier of the certificate request. Only present if no errors returned | -| `commonName` | `string` | Common name of certificate | -| `contact` | `object` | | -| `createdAt` | `string` | The date the certificate was ordered. | -| `deniedReason` | `string` | Only present if certificate order has been denied | -| `organization` | `object` | | -| `period` | `integer` | Validity period of order. Specified in years | -| `productType` | `string` | Certificate product type | -| `progress` | `integer` | Percentage of completion for certificate vetting | -| `revokedAt` | `string` | The revocation date of certificate (if revoked). | -| `rootType` | `string` | Root Type | -| `serialNumber` | `string` | Serial number of certificate (if issued or revoked) | -| `serialNumberHex` | `string` | Hexadecmial format for Serial number of certificate(if issued or revoked) | -| `slotSize` | `string` | Number of subject alternative names(SAN) to be included in certificate | -| `status` | `string` | Status of certificate | -| `subjectAlternativeNames` | `array` | Contains subject alternative names set | -| `validEnd` | `string` | The end date of the certificate's validity (if issued or revoked). | -| `validStart` | `string` | The start date of the certificate's validity (if issued or revoked). | +| | `string` | The unique identifier of the certificate request. Only present if no errors returned | +| | `string` | Common name of certificate | +| | `object` | | +| | `string` | The date the certificate was ordered. | +| | `string` | Only present if certificate order has been denied | +| | `object` | | +| | `integer` | Validity period of order. Specified in years | +| | `string` | Certificate product type | +| | `integer` | Percentage of completion for certificate vetting | +| | `string` | The revocation date of certificate (if revoked). | +| | `string` | Root Type | +| | `string` | Serial number of certificate (if issued or revoked) | +| | `string` | Hexadecmial format for Serial number of certificate(if issued or revoked) | +| | `string` | Number of subject alternative names(SAN) to be included in certificate | +| | `string` | Status of certificate | +| | `array` | Contains subject alternative names set | +| | `string` | The end date of the certificate's validity (if issued or revoked). | +| | `string` | The start date of the certificate's validity (if issued or revoked). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `certificate_get` | `SELECT` | `certificate_id` | Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate. | -| `certificate_create` | `INSERT` | `data__contact, data__csr, data__period, data__productType` | Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'. | -| `certificate_cancel` | `EXEC` | `certificate_id` | Use the cancel call to cancel a pending certificate order. | -| `certificate_download` | `EXEC` | `certificate_id` | Download certificate | -| `certificate_reissue` | `EXEC` | `certificate_id` | Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.' | -| `certificate_renew` | `EXEC` | `certificate_id` | Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate. | -| `certificate_revoke` | `EXEC` | `certificate_id, data__reason` | Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned. | -| `certificate_validate` | `EXEC` | `data__contact, data__csr, data__period, data__productType` | Validate a pending order for certificate | -| `certificate_verifydomaincontrol` | `EXEC` | `certificate_id` | Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452 | +| | `SELECT` | | Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate. | +| | `INSERT` | | Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'. | +| | `EXEC` | | Use the cancel call to cancel a pending certificate order. | +| | `EXEC` | | Download certificate | +| | `EXEC` | | Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.' | +| | `EXEC` | | Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate. | +| | `EXEC` | | Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned. | +| | `EXEC` | | Validate a pending order for certificate | +| | `EXEC` | | Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452 | diff --git a/docs/godaddy-docs/providers/godaddy/certificates/index.md b/docs/godaddy-docs/providers/godaddy/certificates/index.md index 6ee5cd529e..9c62ec7da2 100644 --- a/docs/godaddy-docs/providers/godaddy/certificates/index.md +++ b/docs/godaddy-docs/providers/godaddy/certificates/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/certificates/site_seal/index.md b/docs/godaddy-docs/providers/godaddy/certificates/site_seal/index.md index 1f793b4cc0..5cd30ae5dd 100644 --- a/docs/godaddy-docs/providers/godaddy/certificates/site_seal/index.md +++ b/docs/godaddy-docs/providers/godaddy/certificates/site_seal/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesite_seal
TypeResource
Idgodaddy.certificates.site_seal
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `certificate_siteseal_get` | `SELECT` | `certificate_id` | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/countries/countries/index.md b/docs/godaddy-docs/providers/godaddy/countries/countries/index.md index fe5913642a..2d98adde2a 100644 --- a/docs/godaddy-docs/providers/godaddy/countries/countries/index.md +++ b/docs/godaddy-docs/providers/godaddy/countries/countries/index.md @@ -14,25 +14,28 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecountries
TypeResource
Idgodaddy.countries.countries
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `callingCode` | `string` | The calling code prefix used for phone numbers in this country | -| `countryKey` | `string` | The ISO country-code | -| `label` | `string` | The localized name of the country | -| `states` | `array` | List of states/provinces in this country | +| | `string` | The calling code prefix used for phone numbers in this country | +| | `string` | The ISO country-code | +| | `string` | The localized name of the country | +| | `array` | List of states/provinces in this country | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_countries` | `SELECT` | `marketId` | Retrieves summary country information for the provided marketId and filters. Authorization is not required. | -| `get_country` | `SELECT` | `country_key, marketId` | Retrieves country and summary state information for provided countryKey. Authorization is not required. | +| | `SELECT` | | Retrieves summary country information for the provided marketId and filters. Authorization is not required. | +| | `SELECT` | | Retrieves country and summary state information for provided countryKey. Authorization is not required. | diff --git a/docs/godaddy-docs/providers/godaddy/countries/index.md b/docs/godaddy-docs/providers/godaddy/countries/index.md index bc24130cf7..0f4b7d2e82 100644 --- a/docs/godaddy-docs/providers/godaddy/countries/index.md +++ b/docs/godaddy-docs/providers/godaddy/countries/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/domains/agreements/index.md b/docs/godaddy-docs/providers/godaddy/domains/agreements/index.md index cf438a28c4..5501a0e7c8 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/agreements/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/agreements/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameagreements
TypeResource
Idgodaddy.domains.agreements
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `agreementKey` | `string` | Unique identifier for the legal agreement | -| `content` | `string` | Contents of the legal agreement, suitable for embedding | -| `title` | `string` | Title of the legal agreement | -| `url` | `string` | URL to a page containing the legal agreement | +| | `string` | Unique identifier for the legal agreement | +| | `string` | Contents of the legal agreement, suitable for embedding | +| | `string` | Title of the legal agreement | +| | `string` | URL to a page containing the legal agreement | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_agreement` | `SELECT` | `privacy, tlds` | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/domains/available/index.md b/docs/godaddy-docs/providers/godaddy/domains/available/index.md index 7ae14c28d6..e977cdab6a 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/available/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/available/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameavailable
TypeResource
Idgodaddy.domains.available
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `available` | `boolean` | Whether or not the domain name is available | -| `currency` | `string` | Currency in which the `price` is listed. Only returned if tld is offered | -| `definitive` | `boolean` | Whether or not the `available` answer has been definitively verified with the registry | -| `domain` | `string` | Domain name | -| `period` | `integer` | Number of years included in the price. Only returned if tld is offered | -| `price` | `integer` | Price of the domain excluding taxes or fees. Only returned if tld is offered | +| | `boolean` | Whether or not the domain name is available | +| | `string` | Currency in which the `price` is listed. Only returned if tld is offered | +| | `boolean` | Whether or not the `available` answer has been definitively verified with the registry | +| | `string` | Domain name | +| | `integer` | Number of years included in the price. Only returned if tld is offered | +| | `integer` | Price of the domain excluding taxes or fees. Only returned if tld is offered | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `available` | `SELECT` | `domain` | Determine whether or not the specified domain is available for purchase | -| `available_bulk` | `EXEC` | | Determine whether or not the specified domains are available for purchase | +| | `SELECT` | | Determine whether or not the specified domain is available for purchase | +| | `EXEC` | | Determine whether or not the specified domains are available for purchase | diff --git a/docs/godaddy-docs/providers/godaddy/domains/domains/index.md b/docs/godaddy-docs/providers/godaddy/domains/domains/index.md index a9b00db10c..cf716286ab 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/domains/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/domains/index.md @@ -14,53 +14,56 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Idgodaddy.domains.domains
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `authCode` | `string` | Authorization code for transferring the Domain | -| `contactAdmin` | `object` | | -| `contactBilling` | `object` | | -| `contactRegistrant` | `object` | | -| `contactTech` | `object` | | -| `createdAt` | `string` | Date and time when this domain was created | -| `deletedAt` | `string` | Date and time when this domain was deleted | -| `domain` | `string` | Name of the domain | -| `domainId` | `number` | Unique identifier for this Domain | -| `expirationProtected` | `boolean` | Whether or not the domain is protected from expiration | -| `expires` | `string` | Date and time when this domain will expire | -| `holdRegistrar` | `boolean` | Whether or not the domain is on-hold by the registrar | -| `locked` | `boolean` | Whether or not the domain is locked to prevent transfers | -| `nameServers` | `array` | Fully-qualified domain names for DNS servers | -| `privacy` | `boolean` | Whether or not the domain has privacy protection | -| `renewAuto` | `boolean` | Whether or not the domain is configured to automatically renew | -| `renewDeadline` | `string` | Date the domain must renew on | -| `status` | `string` | Processing status of the domain
ACTIVE - All is well
AWAITING* - System is waiting for the end-user to complete an action
CANCELLED* - Domain has been cancelled, and may or may not be reclaimable
CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud
DISABLED* - Domain has been disabled
EXCLUDED* - Domain has been excluded from Firehose registration
EXPIRED* - Domain has expired
FAILED* - Domain has failed a required action, and the system is no longer retrying
HELD* - Domain has been placed on hold, and likely requires intervention from Support
LOCKED* - Domain has been locked, and likely requires intervention from Support
PARKED* - Domain has been parked, and likely requires intervention from Support
PENDING* - Domain is working its way through an automated workflow
RESERVED* - Domain is reserved, and likely requires intervention from Support
REVERTED - Domain has been reverted, and likely requires intervention from Support
SUSPENDED* - Domain has been suspended, and likely requires intervention from Support
TRANSFERRED* - Domain has been transferred out
UNKNOWN - Domain is in an unknown state
UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support
UNPARKED* - Domain has been unparked, and likely requires intervention from Support
UPDATED* - Domain ownership has been transferred to another account
| -| `subaccountId` | `string` | Reseller subaccount shopperid who can manage the domain | -| `transferProtected` | `boolean` | Whether or not the domain is protected from transfer | -| `verifications` | `object` | | +| | `string` | Authorization code for transferring the Domain | +| | `object` | | +| | `object` | | +| | `object` | | +| | `object` | | +| | `string` | Date and time when this domain was created | +| | `string` | Date and time when this domain was deleted | +| | `string` | Name of the domain | +| | `number` | Unique identifier for this Domain | +| | `boolean` | Whether or not the domain is protected from expiration | +| | `string` | Date and time when this domain will expire | +| | `boolean` | Whether or not the domain is on-hold by the registrar | +| | `boolean` | Whether or not the domain is locked to prevent transfers | +| | `array` | Fully-qualified domain names for DNS servers | +| | `boolean` | Whether or not the domain has privacy protection | +| | `boolean` | Whether or not the domain is configured to automatically renew | +| | `string` | Date the domain must renew on | +| | `string` | Processing status of the domain
ACTIVE - All is well
AWAITING* - System is waiting for the end-user to complete an action
CANCELLED* - Domain has been cancelled, and may or may not be reclaimable
CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud
DISABLED* - Domain has been disabled
EXCLUDED* - Domain has been excluded from Firehose registration
EXPIRED* - Domain has expired
FAILED* - Domain has failed a required action, and the system is no longer retrying
HELD* - Domain has been placed on hold, and likely requires intervention from Support
LOCKED* - Domain has been locked, and likely requires intervention from Support
PARKED* - Domain has been parked, and likely requires intervention from Support
PENDING* - Domain is working its way through an automated workflow
RESERVED* - Domain is reserved, and likely requires intervention from Support
REVERTED - Domain has been reverted, and likely requires intervention from Support
SUSPENDED* - Domain has been suspended, and likely requires intervention from Support
TRANSFERRED* - Domain has been transferred out
UNKNOWN - Domain is in an unknown state
UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support
UNPARKED* - Domain has been unparked, and likely requires intervention from Support
UPDATED* - Domain ownership has been transferred to another account
| +| | `string` | Reseller subaccount shopperid who can manage the domain | +| | `boolean` | Whether or not the domain is protected from transfer | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `domain` | Retrieve details for the specified Domain | -| `list` | `SELECT` | | Retrieve a list of Domains for the specified Shopper | -| `cancel` | `EXEC` | `domain` | Cancel a purchased domain | -| `cancel_privacy` | `EXEC` | `domain` | Submit a privacy cancellation request for the given domain | -| `contacts_validate` | `EXEC` | `data__domains` | All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names | -| `purchase` | `EXEC` | `data__consent, data__domain` | Purchase and register the specified Domain | -| `purchase_privacy` | `EXEC` | `domain, data__consent` | Purchase privacy for a specified domain | -| `renew` | `EXEC` | `domain` | Renew the specified Domain | -| `transfer_in` | `EXEC` | `domain, data__authCode, data__consent` | Purchase and start or restart transfer process | -| `update` | `EXEC` | `domain` | Update details for the specified Domain | -| `update_contacts` | `EXEC` | `domain, data__contactRegistrant` | Update domain | -| `validate` | `EXEC` | `data__consent, data__domain` | Validate the request body using the Domain Purchase Schema for the specified TLD | -| `verify_email` | `EXEC` | `domain` | Re-send Contact E-mail Verification for specified Domain | +| | `SELECT` | | Retrieve details for the specified Domain | +| | `SELECT` | | Retrieve a list of Domains for the specified Shopper | +| | `EXEC` | | Cancel a purchased domain | +| | `EXEC` | | Submit a privacy cancellation request for the given domain | +| | `EXEC` | | All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names | +| | `EXEC` | | Purchase and register the specified Domain | +| | `EXEC` | | Purchase privacy for a specified domain | +| | `EXEC` | | Renew the specified Domain | +| | `EXEC` | | Purchase and start or restart transfer process | +| | `EXEC` | | Update details for the specified Domain | +| | `EXEC` | | Update domain | +| | `EXEC` | | Validate the request body using the Domain Purchase Schema for the specified TLD | +| | `EXEC` | | Re-send Contact E-mail Verification for specified Domain | diff --git a/docs/godaddy-docs/providers/godaddy/domains/identity_documents/index.md b/docs/godaddy-docs/providers/godaddy/domains/identity_documents/index.md index d3f9e18ba6..cdedc983e0 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/identity_documents/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/identity_documents/index.md @@ -14,27 +14,30 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidentity_documents
TypeResource
Idgodaddy.domains.identity_documents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `contact` | `object` | | -| `identificationCountry` | `string` | Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more | -| `identificationNumber` | `string` | Individual or business identification number written on the document. Must match image exactly | -| `identificationType` | `string` | Type of the identity document | -| `identityDocumentId` | `string` | The unique identifier of an identity document | -| `legalEntityName` | `string` | Individual or business name written on the document. Must match image exactly | +| | `object` | | +| | `string` | Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more | +| | `string` | Individual or business identification number written on the document. Must match image exactly | +| | `string` | Type of the identity document | +| | `string` | The unique identifier of an identity document | +| | `string` | Individual or business name written on the document. Must match image exactly | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_identity_documents` | `SELECT` | | Get a collection of identity documents the current shopper owns | -| `create_identity_document` | `INSERT` | `data__contact, data__identificationCountry, data__identificationNumber, data__identificationType, data__image, data__legalEntityName` | Create an Identity Document from uploaded image | +| | `SELECT` | | Get a collection of identity documents the current shopper owns | +| | `INSERT` | | Create an Identity Document from uploaded image | diff --git a/docs/godaddy-docs/providers/godaddy/domains/identity_documents_verifications/index.md b/docs/godaddy-docs/providers/godaddy/domains/identity_documents_verifications/index.md index 147202cfc2..5e3cdeab8e 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/identity_documents_verifications/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/identity_documents_verifications/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidentity_documents_verifications
TypeResource
Idgodaddy.domains.identity_documents_verifications
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `createdAt` | `string` | Timestamp indicating when the user created the identity document verification job | -| `status` | `string` | | -| `tld` | `string` | Top level domain the current identity document verification is for | +| | `string` | Timestamp indicating when the user created the identity document verification job | +| | `string` | | +| | `string` | Top level domain the current identity document verification is for | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_identity_document_verification` | `SELECT` | `identity_document_id` | Retrieve a list of Verifications for the specified Identity Document | -| `create_verification` | `INSERT` | `identity_document_id, tlds` | Only one verification job is needed for one TLD, Top Level Domain, per identity document. Sending in request(s) with multiple domains for the same TLD, will not create multiple verification jobs. We accept domain names for the convenience of our customers so that they don't need to worry about parsing TLDs out of domain names | +| | `SELECT` | | Retrieve a list of Verifications for the specified Identity Document | +| | `INSERT` | | Only one verification job is needed for one TLD, Top Level Domain, per identity document. Sending in request(s) with multiple domains for the same TLD, will not create multiple verification jobs. We accept domain names for the convenience of our customers so that they don't need to worry about parsing TLDs out of domain names | diff --git a/docs/godaddy-docs/providers/godaddy/domains/index.md b/docs/godaddy-docs/providers/godaddy/domains/index.md index 93e1ada7b9..dacaf2c231 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/domains/purchase_schema/index.md b/docs/godaddy-docs/providers/godaddy/domains/purchase_schema/index.md index 338c160cbd..4de6b9d0f1 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/purchase_schema/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/purchase_schema/index.md @@ -14,24 +14,27 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepurchase_schema
TypeResource
Idgodaddy.domains.purchase_schema
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `models` | `object` | -| `properties` | `object` | -| `required` | `array` | +| | `string` | +| | `object` | +| | `object` | +| | `array` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `schema` | `SELECT` | `tld` | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/domains/records/index.md b/docs/godaddy-docs/providers/godaddy/domains/records/index.md index f4f325a4ec..82954be9a4 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/records/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/records/index.md @@ -14,33 +14,36 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerecords
TypeResource
Idgodaddy.domains.records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | | -| `data` | `string` | | -| `port` | `integer` | Service port (SRV only) | -| `priority` | `integer` | Record priority (MX and SRV only) | -| `protocol` | `string` | Service protocol (SRV only) | -| `service` | `string` | Service type (SRV only) | -| `ttl` | `integer` | | -| `type` | `string` | | -| `weight` | `integer` | Record weight (SRV only) | +| | `string` | | +| | `string` | | +| | `integer` | Service port (SRV only) | +| | `integer` | Record priority (MX and SRV only) | +| | `string` | Service protocol (SRV only) | +| | `string` | Service type (SRV only) | +| | `integer` | | +| | `string` | | +| | `integer` | Record weight (SRV only) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `record_get` | `SELECT` | `domain, type` | Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name | -| `record_add` | `EXEC` | `domain` | Add the specified DNS Records to the specified Domain | -| `record_replace` | `EXEC` | `domain` | Replace all DNS Records for the specified Domain | -| `record_replace_type` | `EXEC` | `domain, type` | Replace all DNS Records for the specified Domain with the specified Type | -| `record_replace_type_name` | `EXEC` | `domain, name, type` | Replace all DNS Records for the specified Domain with the specified Type and Name | +| | `SELECT` | | Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name | +| | `EXEC` | | Add the specified DNS Records to the specified Domain | +| | `EXEC` | | Replace all DNS Records for the specified Domain | +| | `EXEC` | | Replace all DNS Records for the specified Domain with the specified Type | +| | `EXEC` | | Replace all DNS Records for the specified Domain with the specified Type and Name | diff --git a/docs/godaddy-docs/providers/godaddy/domains/suggest/index.md b/docs/godaddy-docs/providers/godaddy/domains/suggest/index.md index 0b7106a202..e24b4a4a5d 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/suggest/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/suggest/index.md @@ -14,18 +14,21 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesuggest
TypeResource
Idgodaddy.domains.suggest
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `suggest` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/domains/tlds/index.md b/docs/godaddy-docs/providers/godaddy/domains/tlds/index.md index 926ea4a666..b71e9174cf 100644 --- a/docs/godaddy-docs/providers/godaddy/domains/tlds/index.md +++ b/docs/godaddy-docs/providers/godaddy/domains/tlds/index.md @@ -14,22 +14,25 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametlds
TypeResource
Idgodaddy.domains.tlds
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Name of the top-level domain | -| `type` | `string` | Type of the top-level domain | +| | `string` | Name of the top-level domain | +| | `string` | Type of the top-level domain | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `tlds` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/godaddy-docs/providers/godaddy/orders/index.md b/docs/godaddy-docs/providers/godaddy/orders/index.md index cc7745adb1..752373d88c 100644 --- a/docs/godaddy-docs/providers/godaddy/orders/index.md +++ b/docs/godaddy-docs/providers/godaddy/orders/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/orders/orders/index.md b/docs/godaddy-docs/providers/godaddy/orders/orders/index.md index 942b3adb9a..673a7d4c9c 100644 --- a/docs/godaddy-docs/providers/godaddy/orders/orders/index.md +++ b/docs/godaddy-docs/providers/godaddy/orders/orders/index.md @@ -14,30 +14,33 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameorders
TypeResource
Idgodaddy.orders.orders
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `domains` | `array` | A collection of domain names purchased if the current product is domain | -| `label` | `string` | Human readable description of the current product | -| `period` | `number` | | -| `periodUnit` | `string` | The unit of time that periodCount is measured in | -| `pfid` | `integer` | Unique identifier of the current product | -| `pricing` | `object` | | -| `quantity` | `integer` | Number of the current product included in the specified order | -| `taxCollector` | `object` | | +| | `array` | A collection of domain names purchased if the current product is domain | +| | `string` | Human readable description of the current product | +| | `number` | | +| | `string` | The unit of time that periodCount is measured in | +| | `integer` | Unique identifier of the current product | +| | `object` | | +| | `integer` | Number of the current product included in the specified order | +| | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get` | `SELECT` | `order_id` | -| `list` | `SELECT` | | -| `_list` | `EXEC` | | +| | `SELECT` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/godaddy-docs/providers/godaddy/shoppers/index.md b/docs/godaddy-docs/providers/godaddy/shoppers/index.md index 22eda76faa..d0334568df 100644 --- a/docs/godaddy-docs/providers/godaddy/shoppers/index.md +++ b/docs/godaddy-docs/providers/godaddy/shoppers/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/shoppers/shoppers/index.md b/docs/godaddy-docs/providers/godaddy/shoppers/shoppers/index.md index 5eab79a9b4..d17f895616 100644 --- a/docs/godaddy-docs/providers/godaddy/shoppers/shoppers/index.md +++ b/docs/godaddy-docs/providers/godaddy/shoppers/shoppers/index.md @@ -14,28 +14,31 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameshoppers
TypeResource
Idgodaddy.shoppers.shoppers
Id
## Fields | Name | Datatype | |:-----|:---------| -| `email` | `string` | -| `externalId` | `integer` | -| `marketId` | `string` | -| `nameFirst` | `string` | -| `nameLast` | `string` | -| `shopperId` | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `shopper_id` | Get details for the specified Shopper | -| `create_subaccount` | `INSERT` | `data__email, data__nameFirst, data__nameLast, data__password` | Create a Subaccount owned by the authenticated Reseller | -| `update` | `EXEC` | `shopper_id` | Update details for the specified Shopper | +| | `SELECT` | | Get details for the specified Shopper | +| | `INSERT` | | Create a Subaccount owned by the authenticated Reseller | +| | `EXEC` | | Update details for the specified Shopper | diff --git a/docs/godaddy-docs/providers/godaddy/subscriptions/index.md b/docs/godaddy-docs/providers/godaddy/subscriptions/index.md index 287c0ce345..6328d620e6 100644 --- a/docs/godaddy-docs/providers/godaddy/subscriptions/index.md +++ b/docs/godaddy-docs/providers/godaddy/subscriptions/index.md @@ -13,6 +13,7 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- + :::info Service Summary diff --git a/docs/godaddy-docs/providers/godaddy/subscriptions/subscriptions/index.md b/docs/godaddy-docs/providers/godaddy/subscriptions/subscriptions/index.md index 9557e68d03..417d902b69 100644 --- a/docs/godaddy-docs/providers/godaddy/subscriptions/subscriptions/index.md +++ b/docs/godaddy-docs/providers/godaddy/subscriptions/subscriptions/index.md @@ -14,41 +14,44 @@ description: Query, deploy and manage GoDaddy resources using SQL custom_edit_url: null image: /img/providers/godaddy/stackql-godaddy-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubscriptions
TypeResource
Idgodaddy.subscriptions.subscriptions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `addons` | `array` | An array of additional products that have been purchased to augment this Subscription | -| `billing` | `object` | | -| `cancelable` | `boolean` | Whether or not the Subscription is allowed to be canceled | -| `createdAt` | `string` | When the Subscription was created | -| `expiresAt` | `string` | When the Subscription will expire | -| `label` | `string` | A human readable description of this Subscription | -| `launchUrl` | `string` | The url to use or manage this Subscription's active product | -| `paymentProfileId` | `integer` | Unique identifier of the payment profile that will be used to automatically renew this Subscription | -| `priceLocked` | `boolean` | Whether the renewal price will be based from the list price or a locked-in price for this shopper | -| `product` | `object` | | -| `relations` | `object` | | -| `renewAuto` | `boolean` | Whether or not the Subscription is set to be automatically renewed via the billing agent | -| `renewable` | `boolean` | Whether or not the Subscription is allowed to be renewed | -| `status` | `string` | Whether the Subscription is active or the specific non-active state | -| `subscriptionId` | `string` | Unique identifier of the Subscription | -| `upgradeable` | `boolean` | Whether or not the Subscription is allowed to be upgraded | +| | `array` | An array of additional products that have been purchased to augment this Subscription | +| | `object` | | +| | `boolean` | Whether or not the Subscription is allowed to be canceled | +| | `string` | When the Subscription was created | +| | `string` | When the Subscription will expire | +| | `string` | A human readable description of this Subscription | +| | `string` | The url to use or manage this Subscription's active product | +| | `integer` | Unique identifier of the payment profile that will be used to automatically renew this Subscription | +| | `boolean` | Whether the renewal price will be based from the list price or a locked-in price for this shopper | +| | `object` | | +| | `object` | | +| | `boolean` | Whether or not the Subscription is set to be automatically renewed via the billing agent | +| | `boolean` | Whether or not the Subscription is allowed to be renewed | +| | `string` | Whether the Subscription is active or the specific non-active state | +| | `string` | Unique identifier of the Subscription | +| | `boolean` | Whether or not the Subscription is allowed to be upgraded | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `subscription_id` | Retrieve details for the specified Subscription | -| `list` | `SELECT` | | Retrieve a list of Subscriptions for the specified Shopper | -| `_list` | `EXEC` | | Retrieve a list of Subscriptions for the specified Shopper | -| `cancel` | `EXEC` | `subscription_id` | Cancel the specified Subscription | -| `product_groups` | `EXEC` | | Retrieve a list of ProductGroups for the specified Shopper | -| `update` | `EXEC` | `subscription_id` | Only Subscription properties that can be changed without immediate financial impact can be modified via PATCH, whereas some properties can be changed by purchasing a renewal This endpoint only supports JWT authentication | +| | `SELECT` | | Retrieve details for the specified Subscription | +| | `SELECT` | | Retrieve a list of Subscriptions for the specified Shopper | +| | `EXEC` | | Retrieve a list of Subscriptions for the specified Shopper | +| | `EXEC` | | Cancel the specified Subscription | +| | `EXEC` | | Retrieve a list of ProductGroups for the specified Shopper | +| | `EXEC` | | Only Subscription properties that can be changed without immediate financial impact can be modified via PATCH, whereas some properties can be changed by purchasing a renewal This endpoint only supports JWT authentication | diff --git a/docs/homebrew-docs/index.md b/docs/homebrew-docs/index.md index 798d708ca5..e415616152 100644 --- a/docs/homebrew-docs/index.md +++ b/docs/homebrew-docs/index.md @@ -13,11 +13,13 @@ custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png id: homebrew-doc slug: /providers/homebrew - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Open-source package manager for macOS and Linux. -:::info Provider Summary (v23.12.00194) +:::info Provider Summary (v24.03.00212)
diff --git a/docs/homebrew-docs/providers/homebrew/formula/formula/index.md b/docs/homebrew-docs/providers/homebrew/formula/formula/index.md index ebb5937514..9ddfc7e94a 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/formula/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/formula/index.md @@ -14,69 +14,72 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameformula
TypeResource
Idhomebrew.formula.formula
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the formula. | -| `aliases` | `array` | Alternative names or aliases for the formula. | -| `analytics` | `object` | Analytics data related to the formula, such as download counts or build errors.
| -| `bottle` | `object` | Details about the precompiled binary packages (bottles) for the formula, including URLs and checksums.
| -| `build_dependencies` | `array` | Dependencies required to build the formula from source.
| -| `caveats` | `string` | Special instructions or warnings about the formula that users should be aware of.
| -| `conflicts_with` | `array` | Formula names that conflict with this formula, meaning they cannot be installed simultaneously.
| -| `conflicts_with_reasons` | `array` | Reasons why the formula conflicts with other formulae.
| -| `dependencies` | `array` | Dependencies required to run the formula.
| -| `deprecated` | `boolean` | Whether the formula is deprecated, meaning it is no longer supported or maintained.
| -| `deprecation_date` | `string` | The date on which the formula was deprecated, if it is deprecated.
| -| `deprecation_reason` | `string` | The reason why the formula was deprecated, if it is deprecated.
| -| `desc` | `string` | A short description of the formula.
| -| `disable_date` | `string` | The date on which the formula was disabled, if it is disabled.
| -| `disable_reason` | `string` | The reason why the formula was disabled, if it is disabled.
| -| `disabled` | `boolean` | Whether the formula is disabled, meaning it is not available to install or use.
| -| `full_name` | `string` | The full, qualified name of the formula including the tap name (if applicable). | -| `generated_date` | `string` | The date when the formula information was last generated or updated.
| -| `head_dependencies` | `object` | Dependencies required for installing the HEAD version (directly from the source repository).
| -| `homepage` | `string` | URL to the formula's homepage or project page.
| -| `installed` | `array` | Versions of the formula that are currently installed.
| -| `keg_only` | `boolean` | Whether the formula is keg-only, meaning it is not symlinked into the Homebrew prefix and can be accessed only by its fully qualified name.
| -| `keg_only_reason` | `string` | The reason why the formula is keg-only, if it is keg-only.
| -| `license` | `string` | The license under which the formula is distributed.
| -| `link_overwrite` | `array` | File paths that this formula might request to overwrite during installation.
| -| `linked_keg` | `string` | The version of the formula that is currently linked into Homebrews prefix.
| -| `oldname` | `string` | Previous name for the formula, if it was renamed. | -| `oldnames` | `array` | All previous names the formula had. | -| `optional_dependencies` | `array` | Dependencies that are optional, meaning they are not required to run the formula.
| -| `options` | `array` | Options that can be passed to the formula when installing it.
| -| `outdated` | `boolean` | Whether the formula is outdated, meaning a newer version is available.
| -| `pinned` | `boolean` | Whether the formula is pinned, meaning it is not upgraded when running `brew upgrade`.
| -| `post_install_defined` | `boolean` | Whether a post-installation script is defined for the formula.
| -| `recommended_dependencies` | `array` | Dependencies that are recommended, meaning they are not required to run the formula but are suggested for additional functionality.
| -| `requirements` | `array` | Non-formula requirements for the formula, such as specific hardware or software conditions.
| -| `revision` | `integer` | The package revision number, used for versioning beyond the version number.
| -| `ruby_source_checksum` | `object` | Checksum details for the Ruby source code of the formula.
| -| `ruby_source_path` | `string` | The file path to the Ruby source code of the formula.
| -| `service` | `object` | Details if the formula can run as a service or background process.
| -| `tap` | `string` | The GitHub repository (tap) where the formula is located. | -| `tap_git_head` | `string` | The latest commit SHA of the tap repository containing the formula.
| -| `test_dependencies` | `array` | Dependencies required for running the formulas tests.
| -| `urls` | `object` | URLs related to the formula, such as the source URL.
| -| `uses_from_macos` | `array` | Dependencies that are provided by macOS, which the formula can use.
| -| `uses_from_macos_bounds` | `array` | The minimum and maximum macOS versions that the formula can use.
| -| `variations` | `object` | Different variations of the formula, potentially for different operating systems or configurations.
| -| `version_scheme` | `integer` | Versioning scheme used by the formula.
| -| `versioned_formulae` | `array` | Other versions of the formula available as separate formulae. | -| `versions` | `object` | The version numbers of the formula, including the stable, head, and bottle versions.
| +| | `string` | The name of the formula. | +| | `array` | Alternative names or aliases for the formula. | +| | `object` | Analytics data related to the formula, such as download counts or build errors.
| +| | `object` | Details about the precompiled binary packages (bottles) for the formula, including URLs and checksums.
| +| | `array` | Dependencies required to build the formula from source.
| +| | `string` | Special instructions or warnings about the formula that users should be aware of.
| +| | `array` | Formula names that conflict with this formula, meaning they cannot be installed simultaneously.
| +| | `array` | Reasons why the formula conflicts with other formulae.
| +| | `array` | Dependencies required to run the formula.
| +| | `boolean` | Whether the formula is deprecated, meaning it is no longer supported or maintained.
| +| | `string` | The date on which the formula was deprecated, if it is deprecated.
| +| | `string` | The reason why the formula was deprecated, if it is deprecated.
| +| | `string` | A short description of the formula.
| +| | `string` | The date on which the formula was disabled, if it is disabled.
| +| | `string` | The reason why the formula was disabled, if it is disabled.
| +| | `boolean` | Whether the formula is disabled, meaning it is not available to install or use.
| +| | `string` | The full, qualified name of the formula including the tap name (if applicable). | +| | `string` | The date when the formula information was last generated or updated.
| +| | `object` | Dependencies required for installing the HEAD version (directly from the source repository).
| +| | `string` | URL to the formula's homepage or project page.
| +| | `array` | Versions of the formula that are currently installed.
| +| | `boolean` | Whether the formula is keg-only, meaning it is not symlinked into the Homebrew prefix and can be accessed only by its fully qualified name.
| +| | `string` | The reason why the formula is keg-only, if it is keg-only.
| +| | `string` | The license under which the formula is distributed.
| +| | `array` | File paths that this formula might request to overwrite during installation.
| +| | `string` | The version of the formula that is currently linked into Homebrews prefix.
| +| | `string` | Previous name for the formula, if it was renamed. | +| | `array` | All previous names the formula had. | +| | `array` | Dependencies that are optional, meaning they are not required to run the formula.
| +| | `array` | Options that can be passed to the formula when installing it.
| +| | `boolean` | Whether the formula is outdated, meaning a newer version is available.
| +| | `boolean` | Whether the formula is pinned, meaning it is not upgraded when running `brew upgrade`.
| +| | `boolean` | Whether a post-installation script is defined for the formula.
| +| | `array` | Dependencies that are recommended, meaning they are not required to run the formula but are suggested for additional functionality.
| +| | `array` | Non-formula requirements for the formula, such as specific hardware or software conditions.
| +| | `integer` | The package revision number, used for versioning beyond the version number.
| +| | `object` | Checksum details for the Ruby source code of the formula.
| +| | `string` | The file path to the Ruby source code of the formula.
| +| | `object` | Details if the formula can run as a service or background process.
| +| | `string` | The GitHub repository (tap) where the formula is located. | +| | `string` | The latest commit SHA of the tap repository containing the formula.
| +| | `array` | Dependencies required for running the formulas tests.
| +| | `object` | URLs related to the formula, such as the source URL.
| +| | `array` | Dependencies that are provided by macOS, which the formula can use.
| +| | `array` | The minimum and maximum macOS versions that the formula can use.
| +| | `object` | Different variations of the formula, potentially for different operating systems or configurations.
| +| | `integer` | Versioning scheme used by the formula.
| +| | `array` | Other versions of the formula available as separate formulae. | +| | `object` | The version numbers of the formula, including the stable, head, and bottle versions.
| ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_formula` | `SELECT` | `formula_name` | +| | `SELECT` | | diff --git a/docs/homebrew-docs/providers/homebrew/formula/index.md b/docs/homebrew-docs/providers/homebrew/formula/index.md index fa478534e8..6a5ec206d0 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/index.md @@ -13,6 +13,7 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- + API For Accessing Homebrew Formulae Information. :::info Service Summary @@ -33,7 +34,7 @@ API For Accessing Homebrew Formulae Information. TypeService TitleHomebrew Formulae API DescriptionAPI For Accessing Homebrew Formulae Information. -Idformula:v23.12.00194 +Idformula:v24.03.00212 ## Resources diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_build_errors/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_build_errors/index.md index 5d2d619230..d6f45dd524 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_build_errors/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_build_errors/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_build_errors
TypeResource
Idhomebrew.formula.vw_build_errors
Id
## Fields @@ -29,7 +32,7 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `build_errors_30d` || -| `formula_name` | `text` | +| || +| | `text` | ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_conflicts/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_conflicts/index.md index f395e6ed77..a8b0da6230 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_conflicts/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_conflicts/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_conflicts
TypeResource
Idhomebrew.formula.vw_conflicts
Id
## Fields @@ -29,8 +32,8 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `conflicts_with` || -| `conflicts_with_reasons` || -| `formula_name` | `text` | +| || +| || +| | `text` | ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_dependencies/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_dependencies/index.md index 9f789c48a0..d80c25e950 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_dependencies/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_dependencies/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_dependencies
TypeResource
Idhomebrew.formula.vw_dependencies
Id
## Fields @@ -29,12 +32,12 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `build_dependencies` || -| `dependencies` || -| `formula_name` | `text` | -| `head_dependencies` || -| `optional_dependencies` || -| `recommended_dependencies` || -| `test_dependencies` || +| || +| || +| | `text` | +| || +| || +| || +| || ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_info/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_info/index.md index 013665f116..8c391599ab 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_info/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_info/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_info
TypeResource
Idhomebrew.formula.vw_info
Id
## Fields @@ -29,13 +32,13 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `deprecated` | `boolean` | -| `disabled` | `boolean` | -| `formula_name` | `text` | -| `full_name` | `text` | -| `generated_date` | `text` | -| `homepage` | `text` | -| `latest_version` || -| `license` | `text` | +| | `boolean` | +| | `boolean` | +| | `text` | +| | `text` | +| | `text` | +| | `text` | +| || +| | `text` | ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_lifecycle/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_lifecycle/index.md index f405af3671..8c5cc8b0e7 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_lifecycle/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_lifecycle/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_lifecycle
TypeResource
Idhomebrew.formula.vw_lifecycle
Id
## Fields @@ -29,12 +32,12 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `deprecated` | `boolean` | -| `deprecation_date` | `text` | -| `deprecation_reason` | `text` | -| `disable_date` | `text` | -| `disable_reason` | `text` | -| `disabled` | `boolean` | -| `formula_name` | `text` | +| | `boolean` | +| | `text` | +| | `text` | +| | `text` | +| | `text` | +| | `boolean` | +| | `text` | ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_urls/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_urls/index.md index c421871c19..51cc0dc300 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_urls/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_urls/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_urls
TypeResource
Idhomebrew.formula.vw_urls
Id
## Fields @@ -29,15 +32,15 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `formula_name` | `text` | -| `head_branch` || -| `head_url` || -| `head_using` || -| `homepage` | `text` | -| `stable_checksum` || -| `stable_revision` || -| `stable_tag` || -| `stable_url` || -| `stable_using` || +| | `text` | +| || +| || +| || +| | `text` | +| || +| || +| || +| || +| || ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_usage_metrics/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_usage_metrics/index.md index cb4f4152fa..23d92d2718 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_usage_metrics/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_usage_metrics/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_usage_metrics
TypeResource
Idhomebrew.formula.vw_usage_metrics
Id
## Fields @@ -29,12 +32,12 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `formula_name` | `text` | -| `install_on_requests_30d` || -| `install_on_requests_365d` || -| `install_on_requests_90d` || -| `installs_30d` || -| `installs_365d` || -| `installs_90d` || +| | `text` | +| || +| || +| || +| || +| || +| || ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/homebrew-docs/providers/homebrew/formula/vw_versions/index.md b/docs/homebrew-docs/providers/homebrew/formula/vw_versions/index.md index c1cdc7a941..3cc821ef55 100644 --- a/docs/homebrew-docs/providers/homebrew/formula/vw_versions/index.md +++ b/docs/homebrew-docs/providers/homebrew/formula/vw_versions/index.md @@ -14,14 +14,17 @@ description: Query and report on Homebrew packages using SQL custom_edit_url: null image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_versions
TypeResource
Idhomebrew.formula.vw_versions
Id
## Fields @@ -29,9 +32,9 @@ image: /img/providers/homebrew/stackql-homebrew-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `bottle_available` || -| `formula_name` | `text` | -| `head_version` || -| `stable_version` || +| || +| | `text` | +| || +| || ## Methods -No methods available for the resource +No additional methods available for this resource diff --git a/docs/pagerduty-docs/index.md b/docs/pagerduty-docs/index.md index 35ddb683d0..cd132e8d57 100644 --- a/docs/pagerduty-docs/index.md +++ b/docs/pagerduty-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png id: pagerduty-doc slug: /providers/pagerduty - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Incident management platform for real-time operations and response workflows. :::info Provider Summary (v23.12.00190) @@ -49,7 +51,7 @@ REGISTRY PULL pagerduty; The following system environment variables are used for authentication by default: -- `PAGERDUTY_API_TOKEN` - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) +- - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/pagerduty-docs/providers/pagerduty/abilities/abilities/index.md b/docs/pagerduty-docs/providers/pagerduty/abilities/abilities/index.md index 3832abe72e..2f241485d6 100644 --- a/docs/pagerduty-docs/providers/pagerduty/abilities/abilities/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/abilities/abilities/index.md @@ -14,20 +14,23 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameabilities
TypeResource
Idpagerduty.abilities.abilities
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_abilities` | `SELECT` | | List all of your account's abilities, by name.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| -| `_list_abilities` | `EXEC` | | List all of your account's abilities, by name.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| -| `get_ability` | `EXEC` | `id` | Test whether your account has a given ability.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| +| | `SELECT` | | List all of your account's abilities, by name.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| +| | `EXEC` | | List all of your account's abilities, by name.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| +| | `EXEC` | | Test whether your account has a given ability.

"Abilities" describes your account's capabilities by feature name. For example `"teams"`.

An ability may be available to your account based on things like your pricing plan or account state.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#abilities)

Scoped OAuth requires: `abilities.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/abilities/index.md b/docs/pagerduty-docs/providers/pagerduty/abilities/index.md index f8f972d9b0..4054df3b63 100644 --- a/docs/pagerduty-docs/providers/pagerduty/abilities/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/abilities/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + This Describes Your Account'S Abilities By Feature Name. For Example `"Teams"`. An Ability May Be Available To Your Account Based On Things Like Your Pricing Plan Or Account State. diff --git a/docs/pagerduty-docs/providers/pagerduty/add_ons/addons/index.md b/docs/pagerduty-docs/providers/pagerduty/add_ons/addons/index.md index 851daa9f34..614037f38b 100644 --- a/docs/pagerduty-docs/providers/pagerduty/add_ons/addons/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/add_ons/addons/index.md @@ -14,34 +14,37 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaddons
TypeResource
Idpagerduty.add_ons.addons
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the Add-on. | -| `_type` | `string` | The type of Add-on. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `src` | `string` | The source URL to display in a frame in the PagerDuty UI. HTTPS is required. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the Add-on. | +| | `string` | The type of Add-on. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | The source URL to display in a frame in the PagerDuty UI. HTTPS is required. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_addon` | `SELECT` | `id` | Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| -| `list_addon` | `SELECT` | | List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| -| `create_addon` | `INSERT` | `data__addon` | Install an Add-on for your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| -| `delete_addon` | `DELETE` | `id` | Remove an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| -| `_get_addon` | `EXEC` | `id` | Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| -| `_list_addon` | `EXEC` | | List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| -| `update_addon` | `EXEC` | `id, data__addon` | Update an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| +| | `SELECT` | | Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| +| | `SELECT` | | List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| +| | `INSERT` | | Install an Add-on for your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| +| | `DELETE` | | Remove an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| +| | `EXEC` | | Get details about an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| +| | `EXEC` | | List all of the Add-ons installed on your account.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.read`
| +| | `EXEC` | | Update an existing Add-on.

Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI.

Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#add-ons)

Scoped OAuth requires: `addons.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/add_ons/index.md b/docs/pagerduty-docs/providers/pagerduty/add_ons/index.md index 6cc9f5040e..71c2ca79c5 100644 --- a/docs/pagerduty-docs/providers/pagerduty/add_ons/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/add_ons/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Developers Can Write Their Own Functionality To Insert Into PagerDuty'S UI. diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/index.md index 9dbcd756ad..b3c72421d7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Provides Enriched Incident Data. diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_all/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_all/index.md index d63945e55f..f607a1bf72 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_all/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_all/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_incidents_all
TypeResource
Idpagerduty.analytics.metrics_incidents_all
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `aggregate_unit` | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | -| `data` | `array` | | -| `filters` | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | -| `time_zone` | `string` | The time zone to use for the results and grouping. | +| | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | +| | `array` | | +| | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | +| | `string` | The time zone to use for the results and grouping. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_analytics_metrics_incidents_all` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_services/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_services/index.md index 033c3a06d9..a7d2a82de5 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_services/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_incidents_services
TypeResource
Idpagerduty.analytics.metrics_incidents_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `aggregate_unit` | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | -| `data` | `array` | | -| `filters` | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | -| `time_zone` | `string` | The time zone to use for the results and grouping. | +| | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | +| | `array` | | +| | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | +| | `string` | The time zone to use for the results and grouping. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_analytics_metrics_incidents_service` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_teams/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_teams/index.md index 90370e2f77..29a1667ca4 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_teams/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/metrics_incidents_teams/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_incidents_teams
TypeResource
Idpagerduty.analytics.metrics_incidents_teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `aggregate_unit` | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | -| `data` | `array` | | -| `filters` | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | -| `time_zone` | `string` | The time zone to use for the results and grouping. | +| | `string` | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. | +| | `array` | | +| | `object` | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results | +| | `string` | The time zone to use for the results and grouping. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_analytics_metrics_incidents_team` | `SELECT` | | +| | `SELECT` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents/index.md index a7366eda87..841c85c467 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents/index.md @@ -14,48 +14,51 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameraw_incidents
TypeResource
Idpagerduty.analytics.raw_incidents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Incident ID | -| `description` | `string` | The incident description | -| `assignment_count` | `integer` | Total count of instances where responders were assigned an incident (including through reassignment or escalation) or accepted a responder request. | -| `business_hour_interruptions` | `integer` | Total number of unique interruptions during business hour.
Business hour: 8am-6pm Mon-Fri, based on the user’s time zone. | -| `created_at` | `string` | Timestamp of when the incident was created. | -| `engaged_seconds` | `integer` | Total engaged time across all responders for this incident. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incident was snoozed. | -| `engaged_user_count` | `integer` | Total number of users who engaged (acknowledged, accepted responder request) in the incident. | -| `escalation_count` | `integer` | Total count of instances where an incident is escalated between responders assigned to an escalation policy. | -| `incident_number` | `integer` | The PagerDuty incident number | -| `major` | `boolean` | An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident. | -| `off_hour_interruptions` | `integer` | Total number of unique interruptions during off hour.
Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone. | -| `priority_id` | `string` | ID of the incident's priority level. | -| `priority_name` | `string` | The user-provided short name of the priority. | -| `resolved_at` | `string` | Timestamp of when the incident was resolved. | -| `seconds_to_engage` | `integer` | A measure of *people response time*. This metric measures the time from
the first user engagement (acknowledge or responder accept) to the last.
This metric is only used for incidents with **multiple responders**;
for incidents with one or no engaged users, this value is null. | -| `seconds_to_first_ack` | `integer` | Time between start of an incident, and the first responder to acknowledge. | -| `seconds_to_mobilize` | `integer` | Time between start of an incident, and the last additional responder to acknowledge. If an incident has one or less responders, the value will be null. | -| `seconds_to_resolve` | `integer` | Time from when incident triggered until it was resolved. | -| `service_id` | `string` | ID of the service that the incident triggered on. | -| `service_name` | `string` | Name of the service that the incident triggered on. | -| `sleep_hour_interruptions` | `integer` | Total number of unique interruptions during sleep hour.
Sleep hour: 10pm-8am every day, based on the user’s time zone. | -| `snoozed_seconds` | `integer` | Total seconds the incident has been snoozed for. | -| `team_id` | `string` | ID of the team the incident was assigned to. | -| `team_name` | `string` | Name of the team the incident was assigned to. | -| `urgency` | `string` | Notification level | -| `user_defined_effort_seconds` | `integer` | The total response effort in seconds,
[as defined by the user](https://support.pagerduty.com/docs/editing-incidents#edit-incident-duration). | +| | `string` | Incident ID | +| | `string` | The incident description | +| | `integer` | Total count of instances where responders were assigned an incident (including through reassignment or escalation) or accepted a responder request. | +| | `integer` | Total number of unique interruptions during business hour.
Business hour: 8am-6pm Mon-Fri, based on the user’s time zone. | +| | `string` | Timestamp of when the incident was created. | +| | `integer` | Total engaged time across all responders for this incident. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incident was snoozed. | +| | `integer` | Total number of users who engaged (acknowledged, accepted responder request) in the incident. | +| | `integer` | Total count of instances where an incident is escalated between responders assigned to an escalation policy. | +| | `integer` | The PagerDuty incident number | +| | `boolean` | An incident is classified as a [major incident](https://support.pagerduty.com/docs/operational-reviews#major-incidents) if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident. | +| | `integer` | Total number of unique interruptions during off hour.
Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone. | +| | `string` | ID of the incident's priority level. | +| | `string` | The user-provided short name of the priority. | +| | `string` | Timestamp of when the incident was resolved. | +| | `integer` | A measure of *people response time*. This metric measures the time from
the first user engagement (acknowledge or responder accept) to the last.
This metric is only used for incidents with **multiple responders**;
for incidents with one or no engaged users, this value is null. | +| | `integer` | Time between start of an incident, and the first responder to acknowledge. | +| | `integer` | Time between start of an incident, and the last additional responder to acknowledge. If an incident has one or less responders, the value will be null. | +| | `integer` | Time from when incident triggered until it was resolved. | +| | `string` | ID of the service that the incident triggered on. | +| | `string` | Name of the service that the incident triggered on. | +| | `integer` | Total number of unique interruptions during sleep hour.
Sleep hour: 10pm-8am every day, based on the user’s time zone. | +| | `integer` | Total seconds the incident has been snoozed for. | +| | `string` | ID of the team the incident was assigned to. | +| | `string` | Name of the team the incident was assigned to. | +| | `string` | Notification level | +| | `integer` | The total response effort in seconds,
[as defined by the user](https://support.pagerduty.com/docs/editing-incidents#edit-incident-duration). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_analytics_incidents` | `SELECT` | | Provides enriched incident data and metrics for multiple incidents.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| -| `get_analytics_incidents_by_id` | `SELECT` | `id` | Provides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| -| `_get_analytics_incidents_by_id` | `EXEC` | `id` | Provides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| +| | `SELECT` | | Provides enriched incident data and metrics for multiple incidents.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| +| | `SELECT` | | Provides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| +| | `EXEC` | | Provides enriched incident data and metrics for a single incident.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
<!-- theme: info -->
> **Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.

Scoped OAuth requires: `analytics.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents_responses/index.md b/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents_responses/index.md index e267ad7edf..3d36fa479f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents_responses/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/analytics/raw_incidents_responses/index.md @@ -14,28 +14,31 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameraw_incidents_responses
TypeResource
Idpagerduty.analytics.raw_incidents_responses
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `requested_at` | `string` | Timestamp of when the user was requested. | -| `responded_at` | `string` | Timestamp of when the user responded to the request. | -| `responder_id` | `string` | ID of the user associated with the Incident Response. | -| `responder_name` | `string` | Name of the user associated with the Incident Response. | -| `responder_type` | `string` | Type of responder, where `assigned` means the user was added to the Incident via Assignment at Incident creation,
`reassigned` means the user was added to the Incident via Reassignment, `escalated` means the user was added via Escalation,
and `added_responder` means the user was added via Responder Reqeuest. | -| `response_status` | `string` | Status of the user's interaction with the Incident notification. | -| `time_to_respond_seconds` | `integer` | Measures the time it took for the user to respond to the Incident request. In other words, `responded_at - requested_at`. | +| | `string` | Timestamp of when the user was requested. | +| | `string` | Timestamp of when the user responded to the request. | +| | `string` | ID of the user associated with the Incident Response. | +| | `string` | Name of the user associated with the Incident Response. | +| | `string` | Type of responder, where `assigned` means the user was added to the Incident via Assignment at Incident creation,
`reassigned` means the user was added to the Incident via Reassignment, `escalated` means the user was added via Escalation,
and `added_responder` means the user was added via Responder Reqeuest. | +| | `string` | Status of the user's interaction with the Incident notification. | +| | `integer` | Measures the time it took for the user to respond to the Incident request. In other words, `responded_at - requested_at`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_analytics_incident_responses_by_id` | `SELECT` | `id` | -| `_get_analytics_incident_responses_by_id` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/audit/index.md b/docs/pagerduty-docs/providers/pagerduty/audit/index.md index 00acda9fa3..a9e4b3a9b8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/audit/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/audit/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Provides Audit Record Data. diff --git a/docs/pagerduty-docs/providers/pagerduty/audit/records/index.md b/docs/pagerduty-docs/providers/pagerduty/audit/records/index.md index 18e7452421..e60cbc3fb8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/audit/records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/audit/records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerecords
TypeResource
Idpagerduty.audit.records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_audit_records` | `SELECT` | | -| `_list_audit_records` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions/index.md index 791e8e9799..4535ad2c43 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions/index.md @@ -14,67 +14,70 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Idpagerduty.automation_actions.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `description` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_action_classification` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_action_data_reference` | `object` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_action_type` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_creation_time` | `string` | The date/time | -| `AutomationActionsProcessAutomationJobActionWithTeams_description` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `AutomationActionsProcessAutomationJobActionWithTeams_id` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_last_run` | `string` | The date/time | -| `AutomationActionsProcessAutomationJobActionWithTeams_last_run_by` | `` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_metadata` | `object` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_modify_time` | `string` | The date/time | -| `AutomationActionsProcessAutomationJobActionWithTeams_name` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_privileges` | `object` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_runner` | `string` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_runner_type` | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| -| `AutomationActionsProcessAutomationJobActionWithTeams_self` | `string` | the API show URL at which the object is accessible | -| `AutomationActionsProcessAutomationJobActionWithTeams_services` | `array` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `AutomationActionsProcessAutomationJobActionWithTeams_teams` | `array` | | -| `AutomationActionsProcessAutomationJobActionWithTeams_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `action_classification` | `string` | | -| `action_data_reference` | `object` | | -| `action_type` | `string` | | -| `creation_time` | `string` | The date/time | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `last_run` | `string` | The date/time | -| `last_run_by` | `` | | -| `metadata` | `object` | | -| `modify_time` | `string` | The date/time | -| `privileges` | `object` | | -| `runner` | `string` | | -| `runner_type` | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | | +| | `string` | The date/time | +| | `string` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `string` | The date/time | +| | `` | | +| | `object` | | +| | `string` | The date/time | +| | `string` | | +| | `object` | | +| | `string` | | +| | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| +| | `string` | the API show URL at which the object is accessible | +| | `array` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | | +| | `string` | | +| | `string` | The date/time | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | The date/time | +| | `` | | +| | `object` | | +| | `string` | The date/time | +| | `object` | | +| | `string` | | +| | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| +| | `string` | the API show URL at which the object is accessible | +| | `array` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_all_automation_actions` | `SELECT` | | Lists Automation Actions matching provided query params.

The returned records are sorted by action name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| -| `get_automation_action` | `SELECT` | `id` | Get an Automation Action
| -| `create_automation_action` | `INSERT` | `data__action` | Create a Script, Process Automation, or Runbook Automation action
| -| `create_automation_action_invocation` | `INSERT` | `id, data__invocation` | Invokes an Action
| -| `delete_automation_action` | `DELETE` | `id` | Delete an Automation Action
| -| `_get_all_automation_actions` | `EXEC` | | Lists Automation Actions matching provided query params.

The returned records are sorted by action name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| -| `_get_automation_action` | `EXEC` | `id` | Get an Automation Action
| -| `update_automation_action` | `EXEC` | `id, data__action` | Updates an Automation Action
| +| | `SELECT` | | Lists Automation Actions matching provided query params.

The returned records are sorted by action name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| +| | `SELECT` | | Get an Automation Action
| +| | `INSERT` | | Create a Script, Process Automation, or Runbook Automation action
| +| | `INSERT` | | Invokes an Action
| +| | `DELETE` | | Delete an Automation Action
| +| | `EXEC` | | Lists Automation Actions matching provided query params.

The returned records are sorted by action name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| +| | `EXEC` | | Get an Automation Action
| +| | `EXEC` | | Updates an Automation Action
| diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_services/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_services/index.md index 15220a1a76..cf15a200a2 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_services/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions_services
TypeResource
Idpagerduty.automation_actions.actions_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_automation_actions_action_service_association` | `SELECT` | `id, service_id` | Gets the details of a Automation Action / service relation | -| `get_automation_actions_action_service_associations` | `SELECT` | `id` | Gets all service references associated with an Automation Action | -| `create_automation_action_service_assocation` | `INSERT` | `id, data__service` | Associate an Automation Action with a service
| -| `delete_automation_action_service_association` | `DELETE` | `id, service_id` | Disassociate an Automation Action from a service
| -| `_get_automation_actions_action_service_association` | `EXEC` | `id, service_id` | Gets the details of a Automation Action / service relation | -| `_get_automation_actions_action_service_associations` | `EXEC` | `id` | Gets all service references associated with an Automation Action | +| | `SELECT` | | Gets the details of a Automation Action / service relation | +| | `SELECT` | | Gets all service references associated with an Automation Action | +| | `INSERT` | | Associate an Automation Action with a service
| +| | `DELETE` | | Disassociate an Automation Action from a service
| +| | `EXEC` | | Gets the details of a Automation Action / service relation | +| | `EXEC` | | Gets all service references associated with an Automation Action | diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_teams/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_teams/index.md index 53c9a9b7ea..fdc7ae7b13 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_teams/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/actions_teams/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions_teams
TypeResource
Idpagerduty.automation_actions.actions_teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_automation_actions_action_team_association` | `SELECT` | `id, team_id` | Gets the details of an Automation Action / team relation | -| `get_automation_actions_action_team_associations` | `SELECT` | `id` | Gets all team references associated with an Automation Action | -| `create_automation_action_team_association` | `INSERT` | `id, data__team` | Associate an Automation Action with a team
| -| `delete_automation_action_team_association` | `DELETE` | `id, team_id` | Disassociate an Automation Action from a team
| -| `_get_automation_actions_action_team_association` | `EXEC` | `id, team_id` | Gets the details of an Automation Action / team relation | -| `_get_automation_actions_action_team_associations` | `EXEC` | `id` | Gets all team references associated with an Automation Action | +| | `SELECT` | | Gets the details of an Automation Action / team relation | +| | `SELECT` | | Gets all team references associated with an Automation Action | +| | `INSERT` | | Associate an Automation Action with a team
| +| | `DELETE` | | Disassociate an Automation Action from a team
| +| | `EXEC` | | Gets the details of an Automation Action / team relation | +| | `EXEC` | | Gets all team references associated with an Automation Action | diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/index.md index dd42730245..d7c771de74 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Automation Actions :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/invocations/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/invocations/index.md index 006b0f41fd..d55f04f37d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/invocations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/invocations/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvocations
TypeResource
Idpagerduty.automation_actions.invocations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action_id` | `string` | | -| `action_snapshot` | `object` | | -| `duration` | `integer` | The duration of the invocation's execution time. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `metadata` | `object` | | -| `runner_id` | `string` | | -| `self` | `string` | the API show URL at which the object is accessible | -| `state` | `string` | prepared -- the invocation exists and can be referenced, but is NOT available to a Runner <br> created -- the invocation exists and is waiting for a Runner <br> sent -- invocation sent to a Runner <br> queued -- invocation queued by a Runner <br> running -- invocation is being ran by a Runner <br> aborted -- invocation was aborted on a Runner <br> completed -- invocation completed on a Runner <br> error -- invocation encountered an error on a Runner | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `timing` | `array` | A list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `object` | | +| | `integer` | The duration of the invocation's execution time. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `string` | | +| | `string` | the API show URL at which the object is accessible | +| | `string` | prepared -- the invocation exists and can be referenced, but is NOT available to a Runner <br> created -- the invocation exists and is waiting for a Runner <br> sent -- invocation sent to a Runner <br> queued -- invocation queued by a Runner <br> running -- invocation is being ran by a Runner <br> aborted -- invocation was aborted on a Runner <br> completed -- invocation completed on a Runner <br> error -- invocation encountered an error on a Runner | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | A list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_automation_actions_invocation` | `SELECT` | `id` | Get an Automation Action Invocation
| -| `list_automation_action_invocations` | `SELECT` | `incident_id` | List Invocations
| -| `_get_automation_actions_invocation` | `EXEC` | `id` | Get an Automation Action Invocation
| -| `_list_automation_action_invocations` | `EXEC` | `incident_id` | List Invocations
| +| | `SELECT` | | Get an Automation Action Invocation
| +| | `SELECT` | | List Invocations
| +| | `EXEC` | | Get an Automation Action Invocation
| +| | `EXEC` | | List Invocations
| diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners/index.md index ccc79a75ae..60b87eeeaa 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners/index.md @@ -14,42 +14,45 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerunners
TypeResource
Idpagerduty.automation_actions.runners
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `description` | `string` | | -| `associated_actions` | `object` | References to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions. | -| `creation_time` | `string` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `last_seen` | `string` | | -| `metadata` | `object` | Additional metadata | -| `privileges` | `object` | | -| `runbook_base_uri` | `string` | The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. | -| `runner_type` | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| -| `self` | `string` | the API show URL at which the object is accessible | -| `status` | `string` | Configured -- Runner has connected to the backend at least once
NotConfigured -- Runner has never connected to backend
| -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | The list of teams associated with the Runner | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | | +| | `object` | References to at most 3 actions associated with the Runner. Use appropriate endpoints to retrieve the full list of associated actions. | +| | `string` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | Additional metadata | +| | `object` | | +| | `string` | The base URI of the Runbook server to connect to. May only contain alphanumeric characters, periods, underscores and dashes. | +| | `string` | sidecar -- The runner is backed by an external sidecar that polls for invocations.
runbook -- The runner communicates directly with a runbook instance.
| +| | `string` | the API show URL at which the object is accessible | +| | `string` | Configured -- Runner has connected to the backend at least once
NotConfigured -- Runner has never connected to backend
| +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | The list of teams associated with the Runner | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_automation_actions_runner` | `SELECT` | `id` | Get an Automation Action runner
| -| `get_automation_actions_runners` | `SELECT` | | Lists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| -| `create_automation_actions_runner` | `INSERT` | `data__runner` | Create a Process Automation or a Runbook Automation runner.
| -| `delete_automation_actions_runner` | `DELETE` | `id` | Delete an Automation Action runner
| -| `_get_automation_actions_runner` | `EXEC` | `id` | Get an Automation Action runner
| -| `_get_automation_actions_runners` | `EXEC` | | Lists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| -| `update_automation_actions_runner` | `EXEC` | `id, data__runner` | Update an Automation Action runner
| +| | `SELECT` | | Get an Automation Action runner
| +| | `SELECT` | | Lists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| +| | `INSERT` | | Create a Process Automation or a Runbook Automation runner.
| +| | `DELETE` | | Delete an Automation Action runner
| +| | `EXEC` | | Get an Automation Action runner
| +| | `EXEC` | | Lists Automation Action runners matching provided query params.
The returned records are sorted by runner name in alphabetical order.

See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.
| +| | `EXEC` | | Update an Automation Action runner
| diff --git a/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners_teams/index.md b/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners_teams/index.md index be786d6242..db7eecfe63 100644 --- a/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners_teams/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/automation_actions/runners_teams/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerunners_teams
TypeResource
Idpagerduty.automation_actions.runners_teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_automation_actions_runner_team_association` | `SELECT` | `id, team_id` | Gets the details of a runner / team relation | -| `get_automation_actions_runner_team_associations` | `SELECT` | `id` | Gets all team references associated with a runner | -| `create_automation_actions_runner_team_association` | `INSERT` | `id, data__team` | Associate a runner with a team
| -| `delete_automation_actions_runner_team_association` | `DELETE` | `id, team_id` | Disassociates a runner from a team
| -| `_get_automation_actions_runner_team_association` | `EXEC` | `id, team_id` | Gets the details of a runner / team relation | -| `_get_automation_actions_runner_team_associations` | `EXEC` | `id` | Gets all team references associated with a runner | +| | `SELECT` | | Gets the details of a runner / team relation | +| | `SELECT` | | Gets all team references associated with a runner | +| | `INSERT` | | Associate a runner with a team
| +| | `DELETE` | | Disassociates a runner from a team
| +| | `EXEC` | | Gets the details of a runner / team relation | +| | `EXEC` | | Gets all team references associated with a runner | diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/account_subscription/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/account_subscription/index.md index 2e3dbb8d57..335dc5e3e8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/account_subscription/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/account_subscription/index.md @@ -14,14 +14,17 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaccount_subscription
TypeResource
Idpagerduty.business_services.account_subscription
Id
## Fields @@ -29,6 +32,6 @@ image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `create_business_service_account_subscription` | `INSERT` | `id` | Subscribe your Account to a Business Service.

Scoped OAuth requires: `subscribers.write`
| -| `remove_business_service_account_subscription` | `DELETE` | `id` | Unsubscribe your Account from a Business Service.

Scoped OAuth requires: `subscribers.write`
| -| `remove_business_service_notification_subscriber` | `EXEC` | `id, data__subscribers` | Unsubscribes the matching Subscribers from a Business Service.

Scoped OAuth requires: `subscribers.write`
| +| | `INSERT` | | Subscribe your Account to a Business Service.

Scoped OAuth requires: `subscribers.write`
| +| | `DELETE` | | Unsubscribe your Account from a Business Service.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Unsubscribes the matching Subscribers from a Business Service.

Scoped OAuth requires: `subscribers.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/business_services/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/business_services/index.md index c406edcce8..2317e431a6 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/business_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/business_services/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebusiness_services
TypeResource
Idpagerduty.business_services.business_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the business service. | -| `description` | `string` | The user-provided description of the business service. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `point_of_contact` | `string` | The point of contact assigned to this service. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `team` | `object` | Reference to the team that owns the business service. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the business service. | +| | `string` | The user-provided description of the business service. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | The point of contact assigned to this service. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `object` | Reference to the team that owns the business service. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_business_service` | `SELECT` | `id` | Get details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| -| `list_business_services` | `SELECT` | | List existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| -| `create_business_service` | `INSERT` | | Create a new Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

There is a limit of 5,000 business services per account. If the limit is reached, the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| -| `delete_business_service` | `DELETE` | `id` | Delete an existing Business Service.

Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| -| `_get_business_service` | `EXEC` | `id` | Get details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| -| `_list_business_services` | `EXEC` | | List existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| -| `update_business_service` | `EXEC` | `id` | Update an existing Business Service. NOTE that this endpoint also accepts the PATCH verb.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| +| | `SELECT` | | List existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create a new Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

There is a limit of 5,000 business services per account. If the limit is reached, the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| +| | `DELETE` | | Delete an existing Business Service.

Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | List existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update an existing Business Service. NOTE that this endpoint also accepts the PATCH verb.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/impactors/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/impactors/index.md index aec362c939..674b2aafac 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/impactors/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/impactors/index.md @@ -14,23 +14,26 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimpactors
TypeResource
Idpagerduty.business_services.impactors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `type` | `string` | The kind of object that is impacting | +| | `string` | | +| | `string` | The kind of object that is impacting | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_business_service_top_level_impactors` | `SELECT` | `X-EARLY-ACCESS` | -| `_get_business_service_top_level_impactors` | `EXEC` | `X-EARLY-ACCESS` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/impacts/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/impacts/index.md index 82389cbc2a..bd922f71b8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/impacts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/impacts/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimpacts
TypeResource
Idpagerduty.business_services.impacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `additional_fields` | `object` | | -| `status` | `string` | The current impact status of the object | -| `type` | `string` | The kind of object that has been impacted | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | The current impact status of the object | +| | `string` | The kind of object that has been impacted | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_business_service_impacts` | `SELECT` | `X-EARLY-ACCESS` | -| `_get_business_service_impacts` | `EXEC` | `X-EARLY-ACCESS` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/index.md index 92b2192876..a503a116aa 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Business Services :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/priority_thresholds/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/priority_thresholds/index.md index bfab7303ce..c3e517b71f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/priority_thresholds/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/priority_thresholds/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepriority_thresholds
TypeResource
Idpagerduty.business_services.priority_thresholds
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `order` | `integer` | +| | `string` | +| | `integer` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_business_service_priority_thresholds` | `SELECT` | `X-EARLY-ACCESS` | Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `delete_business_service_priority_thresholds` | `DELETE` | `X-EARLY-ACCESS` | Clears the Priority Threshold for the account. If the priority threshold is cleared, any Incident with a Priority set will be able to impact Business Services.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `_get_business_service_priority_thresholds` | `EXEC` | `X-EARLY-ACCESS` | Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `put_business_service_priority_thresholds` | `EXEC` | `X-EARLY-ACCESS, data__global_threshold` | Set the Account-level priority threshold for Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `SELECT` | | Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `DELETE` | | Clears the Priority Threshold for the account. If the priority threshold is cleared, any Incident with a Priority set will be able to impact Business Services.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Set the Account-level priority threshold for Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/subscribers/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/subscribers/index.md index 8db51f8778..707223fc64 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/subscribers/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/subscribers/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesubscribers
TypeResource
Idpagerduty.business_services.subscribers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `subscriber_id` | `string` | The ID of the entity being subscribed | -| `subscriber_type` | `string` | The type of the entity being subscribed | +| | `string` | The ID of the entity being subscribed | +| | `string` | The type of the entity being subscribed | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_business_service_subscribers` | `SELECT` | `id` | Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| -| `create_business_service_notification_subscribers` | `INSERT` | `id, data__subscribers` | Subscribe the given entities to the given Business Service.

Scoped OAuth requires: `subscribers.write`
| -| `_get_business_service_subscribers` | `EXEC` | `id` | Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| +| | `SELECT` | | Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| +| | `INSERT` | | Subscribe the given entities to the given Business Service.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/business_services/supporting_services_impacts/index.md b/docs/pagerduty-docs/providers/pagerduty/business_services/supporting_services_impacts/index.md index 87b0d62ef9..43fce28a1c 100644 --- a/docs/pagerduty-docs/providers/pagerduty/business_services/supporting_services_impacts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/business_services/supporting_services_impacts/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesupporting_services_impacts
TypeResource
Idpagerduty.business_services.supporting_services_impacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `additional_fields` | `object` | | -| `status` | `string` | The current impact status of the object | -| `type` | `string` | The kind of object that has been impacted | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | The current impact status of the object | +| | `string` | The kind of object that has been impacted | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_business_service_supporting_service_impacts` | `SELECT` | `X-EARLY-ACCESS, id` | -| `_get_business_service_supporting_service_impacts` | `EXEC` | `X-EARLY-ACCESS, id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/change_events/change_events/index.md b/docs/pagerduty-docs/providers/pagerduty/change_events/change_events/index.md index 337799d264..cd248055dd 100644 --- a/docs/pagerduty-docs/providers/pagerduty/change_events/change_events/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/change_events/change_events/index.md @@ -14,40 +14,43 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namechange_events
TypeResource
Idpagerduty.change_events.change_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_summary` | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | -| `_type` | `string` | The type of object being created. | -| `custom_details` | `object` | Additional details about the change event. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `images` | `array` | | -| `integration` | `` | | -| `links` | `array` | List of links to include. | -| `routing_key` | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | An array containing Service objects that this change event is associated with. | -| `source` | `string` | The unique name of the location where the Change Event occurred. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `timestamp` | `string` | The time at which the emitting tool detected or generated the event. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | +| | `string` | The type of object being created. | +| | `object` | Additional details about the change event. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `array` | | +| | `` | | +| | `array` | List of links to include. | +| | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | +| | `string` | the API show URL at which the object is accessible | +| | `array` | An array containing Service objects that this change event is associated with. | +| | `string` | The unique name of the location where the Change Event occurred. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The time at which the emitting tool detected or generated the event. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_change_event` | `SELECT` | `id` | Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
| -| `list_change_events` | `SELECT` | | List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
| -| `create_change_event` | `INSERT` | | Sending Change Events is documented as part of the V2 Events API. See [`Send Change Event`](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).
| -| `_get_change_event` | `EXEC` | `id` | Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
| -| `_list_change_events` | `EXEC` | | List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
| -| `update_change_event` | `EXEC` | `id, data__change_event` | Update an existing Change Event

Scoped OAuth requires: `change_events.write`
| +| | `SELECT` | | Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
| +| | `SELECT` | | List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
| +| | `INSERT` | | Sending Change Events is documented as part of the V2 Events API. See [`Send Change Event`](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).
| +| | `EXEC` | | Get details about an existing Change Event.

Scoped OAuth requires: `change_events.read`
| +| | `EXEC` | | List all of the existing Change Events.

Scoped OAuth requires: `change_events.read`
| +| | `EXEC` | | Update an existing Change Event

Scoped OAuth requires: `change_events.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/change_events/incidents_related_change_events/index.md b/docs/pagerduty-docs/providers/pagerduty/change_events/incidents_related_change_events/index.md index 491ebd5c1f..b736f42b56 100644 --- a/docs/pagerduty-docs/providers/pagerduty/change_events/incidents_related_change_events/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/change_events/incidents_related_change_events/index.md @@ -14,37 +14,40 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincidents_related_change_events
TypeResource
Idpagerduty.change_events.incidents_related_change_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_summary` | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | -| `_type` | `string` | The type of object being created. | -| `correlation_reason` | `object` | | -| `custom_details` | `object` | Additional details about the change event. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `images` | `array` | | -| `integration` | `` | | -| `links` | `array` | List of links to include. | -| `routing_key` | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | An array containing Service objects that this change event is associated with. | -| `source` | `string` | The unique name of the location where the Change Event occurred. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `timestamp` | `string` | The time at which the emitting tool detected or generated the event. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | +| | `string` | The type of object being created. | +| | `object` | | +| | `object` | Additional details about the change event. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `array` | | +| | `` | | +| | `array` | List of links to include. | +| | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | +| | `string` | the API show URL at which the object is accessible | +| | `array` | An array containing Service objects that this change event is associated with. | +| | `string` | The unique name of the location where the Change Event occurred. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The time at which the emitting tool detected or generated the event. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_incident_related_change_events` | `SELECT` | `id` | -| `_list_incident_related_change_events` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/change_events/index.md b/docs/pagerduty-docs/providers/pagerduty/change_events/index.md index 2ba6e9dc70..585b116404 100644 --- a/docs/pagerduty-docs/providers/pagerduty/change_events/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/change_events/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Change Events :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/change_events/services/index.md b/docs/pagerduty-docs/providers/pagerduty/change_events/services/index.md index 728d7946e5..551eabf84c 100644 --- a/docs/pagerduty-docs/providers/pagerduty/change_events/services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/change_events/services/index.md @@ -14,36 +14,39 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices
TypeResource
Idpagerduty.change_events.services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_summary` | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | -| `_type` | `string` | The type of object being created. | -| `custom_details` | `object` | Additional details about the change event. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `images` | `array` | | -| `integration` | `` | | -| `links` | `array` | List of links to include. | -| `routing_key` | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | An array containing Service objects that this change event is associated with. | -| `source` | `string` | The unique name of the location where the Change Event occurred. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `timestamp` | `string` | The time at which the emitting tool detected or generated the event. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. | +| | `string` | The type of object being created. | +| | `object` | Additional details about the change event. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `array` | | +| | `` | | +| | `array` | List of links to include. | +| | `string` | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. | +| | `string` | the API show URL at which the object is accessible | +| | `array` | An array containing Service objects that this change event is associated with. | +| | `string` | The unique name of the location where the Change Event occurred. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The time at which the emitting tool detected or generated the event. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_service_change_events` | `SELECT` | `id` | -| `_list_service_change_events` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields/index.md index 628e14540d..dbc48a389b 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields/index.md @@ -14,38 +14,41 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecustomfields_fields
TypeResource
Idpagerduty.custom_fields.customfields_fields
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `description` | `string` | A description of the data this field contains. | -| `created_at` | `string` | The date/time the object was created at. | -| `datatype` | `string` | The kind of data the custom field is allowed to contain. | -| `display_name` | `string` | The human-readable name of the field. This must be unique across an account. | -| `field_options` | `array` | The fixed list of value options that may be stored in this field. | -| `fixed_options` | `boolean` | If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime" | -| `multi_value` | `boolean` | If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url" | -| `self` | `string` | The API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | A description of the data this field contains. | +| | `string` | The date/time the object was created at. | +| | `string` | The kind of data the custom field is allowed to contain. | +| | `string` | The human-readable name of the field. This must be unique across an account. | +| | `array` | The fixed list of value options that may be stored in this field. | +| | `boolean` | If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime" | +| | `boolean` | If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url" | +| | `string` | The API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_custom_fields_field` | `SELECT` | `X-EARLY-ACCESS, field_id` | Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `list_custom_fields_fields` | `SELECT` | `X-EARLY-ACCESS` | List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `create_custom_fields_field` | `INSERT` | `X-EARLY-ACCESS, data__field` | Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `delete_custom_fields_field` | `DELETE` | `X-EARLY-ACCESS, field_id` | Delete a Field. Fields may not be deleted if they are used by a Field Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_get_custom_fields_field` | `EXEC` | `X-EARLY-ACCESS, field_id` | Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_list_custom_fields_fields` | `EXEC` | `X-EARLY-ACCESS` | List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `update_custom_fields_field` | `EXEC` | `X-EARLY-ACCESS, field_id, data__field` | Update a field.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `INSERT` | | Create a new Field, along with the Field Options if provided. An account may have up to 1000 Fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `DELETE` | | Delete a Field. Fields may not be deleted if they are used by a Field Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Show detailed information about a field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | List fields.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Update a field.

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields_field_options/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields_field_options/index.md index 4e80098e9f..b453389fcf 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields_field_options/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/customfields_fields_field_options/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecustomfields_fields_field_options
TypeResource
Idpagerduty.custom_fields.customfields_fields_field_options
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `created_at` | `string` | The date/time the object was created at. | -| `data` | `` | | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | The date/time the object was created at. | +| | `` | | +| | `string` | | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_custom_fields_field_option` | `SELECT` | `X-EARLY-ACCESS, field_id, field_option_id` | Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `list_custom_fields_field_options` | `SELECT` | `X-EARLY-ACCESS, field_id` | List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `create_custom_fields_field_option` | `INSERT` | `X-EARLY-ACCESS, field_id, data__field_option` | Create a new Field Option. Field Options may only be created for Fields where `fixed_options` is `true`. A Field may have no more than 10 enabled options.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `delete_custom_fields_field_option` | `DELETE` | `X-EARLY-ACCESS, field_id, field_option_id` | Delete a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_get_custom_fields_field_option` | `EXEC` | `X-EARLY-ACCESS, field_id, field_option_id` | Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_list_custom_fields_field_options` | `EXEC` | `X-EARLY-ACCESS, field_id` | List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `update_custom_fields_field_option` | `EXEC` | `X-EARLY-ACCESS, field_id, field_option_id, data__field_option` | Update Field Option for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `INSERT` | | Create a new Field Option. Field Options may only be created for Fields where `fixed_options` is `true`. A Field may have no more than 10 enabled options.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `DELETE` | | Delete a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Get a Field Option.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | List all enabled Field Options for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Update Field Option for a Field.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/field_configurations/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/field_configurations/index.md index 67d7a9e2f5..151197edc5 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/field_configurations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/field_configurations/index.md @@ -14,34 +14,37 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefield_configurations
TypeResource
Idpagerduty.custom_fields.field_configurations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `_type` | `string` | | -| `created_at` | `string` | The date/time the object was created at. | -| `default_value` | `object` | The value to use for this field if none is provided. It must be specified if `required` is `true`. | -| `field` | `` | The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. | -| `required` | `boolean` | If `true`, this Field must always have a value set for objects using this schema. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | | +| | `string` | The date/time the object was created at. | +| | `object` | The value to use for this field if none is provided. It must be specified if `required` is `true`. | +| | `` | The Field to be included in this schema. Each Field may only be used in one Field Configuration per schema. | +| | `boolean` | If `true`, this Field must always have a value set for objects using this schema. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_custom_fields_field_configuration` | `SELECT` | `X-EARLY-ACCESS, field_configuration_id, schema_id` | Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `list_custom_fields_field_configurations` | `SELECT` | `X-EARLY-ACCESS, schema_id` | List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `create_custom_fields_field_configuration` | `INSERT` | `X-EARLY-ACCESS, schema_id, data__field_configuration` | Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `delete_custom_fields_field_configuration` | `DELETE` | `X-EARLY-ACCESS, field_configuration_id, schema_id` | Remove a Field Configuration and its associated Field from a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_get_custom_fields_field_configuration` | `EXEC` | `X-EARLY-ACCESS, field_configuration_id, schema_id` | Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_list_custom_fields_field_configurations` | `EXEC` | `X-EARLY-ACCESS, schema_id` | List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `update_custom_fields_field_configuration` | `EXEC` | `X-EARLY-ACCESS, field_configuration_id, schema_id, data__field_configuration` | Update settings for Field Configuration in Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `INSERT` | | Add a new Field Configuration to an existing Schema. A Schema may use at most 20 Fields, and so may have at most 20 Field Configurations.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `DELETE` | | Remove a Field Configuration and its associated Field from a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Show detailed information about a Field Configuration.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | List all Field Configurations for the given Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Update settings for Field Configuration in Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/fields_schemas/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/fields_schemas/index.md index d6f489e4f4..be9c405ff8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/fields_schemas/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/fields_schemas/index.md @@ -14,29 +14,32 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefields_schemas
TypeResource
Idpagerduty.custom_fields.fields_schemas
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `description` | `string` | A description of this schema. | -| `created_at` | `string` | The date/time the object was created at. | -| `self` | `string` | The API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `title` | `string` | The name of the schema. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | A description of this schema. | +| | `string` | The date/time the object was created at. | +| | `string` | The API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The name of the schema. | +| | `string` | | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_custom_fields_schemas_using_field` | `SELECT` | `X-EARLY-ACCESS, field_id` | -| `_list_custom_fields_schemas_using_field` | `EXEC` | `X-EARLY-ACCESS, field_id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/index.md index f0828bf366..73359c51e6 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Custom Fields :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/schema_assignments/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/schema_assignments/index.md index 179ac32f70..e229e5bddd 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/schema_assignments/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/schema_assignments/index.md @@ -14,29 +14,32 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameschema_assignments
TypeResource
Idpagerduty.custom_fields.schema_assignments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `created_at` | `string` | The date/time the object was created at. | -| `schema` | `object` | | -| `service` | `object` | | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | The date/time the object was created at. | +| | `object` | | +| | `object` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_schema_assignments` | `SELECT` | `X-EARLY-ACCESS, filter` | List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `create_custom_fields_schema_assignment` | `INSERT` | `X-EARLY-ACCESS, data__schema_assignment` | Assign a new Schema to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `delete_schema_assignment` | `DELETE` | `X-EARLY-ACCESS, id` | Remove the Schema assigned to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_list_schema_assignments` | `EXEC` | `X-EARLY-ACCESS, filter` | List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `INSERT` | | Assign a new Schema to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `DELETE` | | Remove the Schema assigned to a service

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | List Schema Assignments by `service_id` or `schema_id`

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/custom_fields/schemas/index.md b/docs/pagerduty-docs/providers/pagerduty/custom_fields/schemas/index.md index ef549db1e3..46871c25f1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/custom_fields/schemas/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/custom_fields/schemas/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameschemas
TypeResource
Idpagerduty.custom_fields.schemas
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `description` | `string` | A description of this schema. | -| `created_at` | `string` | The date/time the object was created at. | -| `field_configurations` | `array` | | -| `self` | `string` | The API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `title` | `string` | The name of the schema. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | +| | `string` | The ID of the resource. | +| | `string` | A description of this schema. | +| | `string` | The date/time the object was created at. | +| | `array` | | +| | `string` | The API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The name of the schema. | +| | `string` | | +| | `string` | The date/time the object was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_custom_fields_schema` | `SELECT` | `X-EARLY-ACCESS, schema_id` | Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `list_custom_fields_schemas` | `SELECT` | `X-EARLY-ACCESS` | List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `create_custom_fields_schema` | `INSERT` | `X-EARLY-ACCESS, data__schema` | Create a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `delete_custom_fields_schema` | `DELETE` | `X-EARLY-ACCESS, schema_id` | Delete a Schema. Schemas may not be deleted if they are in use by any Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_get_custom_fields_schema` | `EXEC` | `X-EARLY-ACCESS, schema_id` | Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_list_custom_fields_schemas` | `EXEC` | `X-EARLY-ACCESS` | List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `update_custom_fields_schema` | `EXEC` | `X-EARLY-ACCESS, schema_id, data__schema` | Update a Schema, along with the Field Configurations if provided.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `INSERT` | | Create a new Schema, along with the Field Configurations if provided. An account may have up to 100 Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `DELETE` | | Delete a Schema. Schemas may not be deleted if they are in use by any Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Get detailed information about a Schema.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | List all Schemas.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Update a Schema, along with the Field Configurations if provided.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/audit_records/index.md b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/audit_records/index.md index 460a1d2c24..4de099ef2f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/audit_records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/audit_records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_records
TypeResource
Idpagerduty.escalation_policies.audit_records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_escalation_policy_audit_records` | `SELECT` | `id` | -| `_list_escalation_policy_audit_records` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/escalation_policies/index.md b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/escalation_policies/index.md index 91579ee0cb..f42acc930f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/escalation_policies/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/escalation_policies/index.md @@ -14,39 +14,42 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameescalation_policies
TypeResource
Idpagerduty.escalation_policies.escalation_policies
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the escalation policy. | -| `description` | `string` | Escalation policy description. | -| `_type` | `string` | The type of object being created. | -| `escalation_rules` | `array` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `num_loops` | `integer` | The number of times the escalation policy will repeat after reaching the end of its escalation. | -| `on_call_handoff_notifications` | `string` | Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". | -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the escalation policy. | +| | `string` | Escalation policy description. | +| | `string` | The type of object being created. | +| | `array` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `integer` | The number of times the escalation policy will repeat after reaching the end of its escalation. | +| | `string` | Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". | +| | `string` | the API show URL at which the object is accessible | +| | `array` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_escalation_policy` | `SELECT` | `id` | Get information about an existing escalation policy and its rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| -| `list_escalation_policies` | `SELECT` | | List all of the existing escalation policies.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| -| `create_escalation_policy` | `INSERT` | `data__escalation_policy` | Creates a new escalation policy. At least one escalation rule must be provided.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| -| `delete_escalation_policy` | `DELETE` | `id` | Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| -| `_get_escalation_policy` | `EXEC` | `id` | Get information about an existing escalation policy and its rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| -| `_list_escalation_policies` | `EXEC` | | List all of the existing escalation policies.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| -| `update_escalation_policy` | `EXEC` | `id, data__escalation_policy` | Updates an existing escalation policy and rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| +| | `SELECT` | | Get information about an existing escalation policy and its rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| +| | `SELECT` | | List all of the existing escalation policies.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| +| | `INSERT` | | Creates a new escalation policy. At least one escalation rule must be provided.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| +| | `DELETE` | | Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| +| | `EXEC` | | Get information about an existing escalation policy and its rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| +| | `EXEC` | | List all of the existing escalation policies.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.read`
| +| | `EXEC` | | Updates an existing escalation policy and rules.

Escalation policies define which user should be alerted at which time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)

Scoped OAuth requires: `escalation_policies.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/index.md b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/index.md index f2ce9bf50f..be9969de1f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/escalation_policies/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/escalation_policies/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Escalation Policies :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/event_orchestrations/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/event_orchestrations/index.md index e60b99a410..a951213025 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/event_orchestrations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/event_orchestrations/index.md @@ -14,38 +14,41 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevent_orchestrations
TypeResource
Idpagerduty.event_orchestrations.event_orchestrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the Orchestration. | -| `name` | `string` | Name of the Orchestration. | -| `description` | `string` | A description of this Orchestration's purpose. | -| `created_at` | `string` | The date the Orchestration was created at. | -| `created_by` | `object` | Reference to the user that has created the Orchestration. | -| `integrations` | `array` | | -| `routes` | `integer` | Number of different Service Orchestration being routed to | -| `self` | `string` | The API show URL at which the object is accessible | -| `team` | `object` | Reference to the team that owns the Orchestration. If none is specified, only admins have access. | -| `updated_at` | `string` | The date the Orchestration was last updated. | -| `updated_by` | `object` | Reference to the user that has updated the Orchestration last. | -| `version` | `string` | Version of the Orchestration. | +| | `string` | ID of the Orchestration. | +| | `string` | Name of the Orchestration. | +| | `string` | A description of this Orchestration's purpose. | +| | `string` | The date the Orchestration was created at. | +| | `object` | Reference to the user that has created the Orchestration. | +| | `array` | | +| | `integer` | Number of different Service Orchestration being routed to | +| | `string` | The API show URL at which the object is accessible | +| | `object` | Reference to the team that owns the Orchestration. If none is specified, only admins have access. | +| | `string` | The date the Orchestration was last updated. | +| | `object` | Reference to the user that has updated the Orchestration last. | +| | `string` | Version of the Orchestration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orchestration` | `SELECT` | `id` | Get a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `list_event_orchestrations` | `SELECT` | | List all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `delete_orchestration` | `DELETE` | `id` | Delete a Global Event Orchestration.

Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration's Routing Key.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| -| `_get_orchestration` | `EXEC` | `id` | Get a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `_list_event_orchestrations` | `EXEC` | | List all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `post_orchestration` | `EXEC` | `data__orchestration` | Create a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| -| `update_orchestration` | `EXEC` | `id, data__orchestration` | Update a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `SELECT` | | Get a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `SELECT` | | List all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `DELETE` | | Delete a Global Event Orchestration.

Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration's Routing Key.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `EXEC` | | Get a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | List all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Create a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `EXEC` | | Update a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/global/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/global/index.md index 9379080bb2..c406546fdc 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/global/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/global/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameglobal
TypeResource
Idpagerduty.event_orchestrations.global
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `catch_all` | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | -| `created_at` | `string` | The date/time the object was created. | -| `created_by` | `object` | Reference to the user that created the object. | -| `parent` | `object` | | -| `sets` | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | -| `updated_by` | `object` | Reference to the user that last updated the object. | -| `version` | `string` | Version of these Orchestration Rules | +| | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | +| | `string` | The date/time the object was created. | +| | `object` | Reference to the user that created the object. | +| | `object` | | +| | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | +| | `string` | | +| | `string` | The date/time the object was last updated. | +| | `object` | Reference to the user that last updated the object. | +| | `string` | Version of these Orchestration Rules | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orch_path_global` | `SELECT` | `id` | Get the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `_get_orch_path_global` | `EXEC` | `id` | Get the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `update_orch_path_global` | `EXEC` | `id` | Update the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `SELECT` | | Get the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Get the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Update the Global Orchestration for an Event Orchestration.

Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/index.md index 3bca062667..eccda0d2e2 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Event Orchestrations :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/integrations/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/integrations/index.md index 1006c2fc0c..115e30ad45 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/integrations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/integrations/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameintegrations
TypeResource
Idpagerduty.event_orchestrations.integrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the Integration. | -| `label` | `string` | Name of the Integration. | -| `parameters` | `object` | | +| | `string` | ID of the Integration. | +| | `string` | Name of the Integration. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orchestration_integration` | `SELECT` | `id, integration_id` | Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `list_orchestration_integrations` | `SELECT` | `id` | List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `delete_orchestration_integration` | `DELETE` | `id, integration_id` | Delete an Integration and its associated Routing Key.

Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| -| `_get_orchestration_integration` | `EXEC` | `id, integration_id` | Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `_list_orchestration_integrations` | `EXEC` | `id` | List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `migrate_orchestration_integration` | `EXEC` | `id, data__integration_id, data__source_id, data__source_type` | Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL.

Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| -| `post_orchestration_integration` | `EXEC` | `id, data__integration` | Create an Integration associated with this Event Orchestration.

You can then use the Routing Key from this new Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| -| `update_orchestration_integration` | `EXEC` | `id, integration_id, data__integration` | Update an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `SELECT` | | Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `SELECT` | | List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `DELETE` | | Delete an Integration and its associated Routing Key.

Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `EXEC` | | Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL.

Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `EXEC` | | Create an Integration associated with this Event Orchestration.

You can then use the Routing Key from this new Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `EXEC` | | Update an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/router/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/router/index.md index 5935dff775..581f93bd5d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/router/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/router/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerouter
TypeResource
Idpagerduty.event_orchestrations.router
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `catch_all` | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | -| `created_at` | `string` | The date/time the object was created. | -| `created_by` | `object` | Reference to the user that created the object. | -| `parent` | `object` | | -| `sets` | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | -| `updated_by` | `object` | Reference to the user that last updated the object. | -| `version` | `string` | Version of these Orchestration Rules | +| | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | +| | `string` | The date/time the object was created. | +| | `object` | Reference to the user that created the object. | +| | `object` | | +| | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | +| | `string` | | +| | `string` | The date/time the object was last updated. | +| | `object` | Reference to the user that last updated the object. | +| | `string` | Version of these Orchestration Rules | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orch_path_router` | `SELECT` | `id` | Get a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `_get_orch_path_router` | `EXEC` | `id` | Get a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `update_orch_path_router` | `EXEC` | `id` | Update a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `SELECT` | | Get a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Get a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Update a Global Orchestration's Routing Rules.

An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services/index.md index 4777eb884e..97232f9ca2 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices
TypeResource
Idpagerduty.event_orchestrations.services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `catch_all` | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | -| `created_at` | `string` | The date/time the object was created. | -| `created_by` | `object` | Reference to the user that created the object. | -| `parent` | `object` | | -| `sets` | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | -| `updated_by` | `object` | Reference to the user that last updated the object. | -| `version` | `string` | Version of these Orchestration Rules | +| | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | +| | `string` | The date/time the object was created. | +| | `object` | Reference to the user that created the object. | +| | `object` | | +| | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | +| | `string` | | +| | `string` | The date/time the object was last updated. | +| | `object` | Reference to the user that last updated the object. | +| | `string` | Version of these Orchestration Rules | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orch_path_service` | `SELECT` | `service_id` | Get a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| -| `_get_orch_path_service` | `EXEC` | `service_id` | Get a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| -| `update_orch_path_service` | `EXEC` | `service_id` | Update a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Get a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update a Service Orchestration.

A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services_active/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services_active/index.md index e6633a7297..817c985078 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services_active/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/services_active/index.md @@ -14,20 +14,23 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices_active
TypeResource
Idpagerduty.event_orchestrations.services_active
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orch_active_status` | `SELECT` | `service_id` | Get a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| -| `_get_orch_active_status` | `EXEC` | `service_id` | Get a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| -| `update_orch_active_status` | `EXEC` | `service_id` | Update a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Get a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update a Service Orchestration's active status.

A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/unrouted/index.md b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/unrouted/index.md index 15502d3454..e0ab1aeec7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/unrouted/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/event_orchestrations/unrouted/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameunrouted
TypeResource
Idpagerduty.event_orchestrations.unrouted
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `catch_all` | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | -| `created_at` | `string` | The date/time the object was created. | -| `created_by` | `object` | Reference to the user that created the object. | -| `parent` | `object` | | -| `sets` | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | -| `type` | `string` | | -| `updated_at` | `string` | The date/time the object was last updated. | -| `updated_by` | `object` | Reference to the user that last updated the object. | -| `version` | `string` | Version of these Orchestration Rules | +| | `object` | When none of the Rules in a set match an event, we apply the catch_all actions to the event. | +| | `string` | The date/time the object was created. | +| | `object` | Reference to the user that created the object. | +| | `object` | | +| | `array` | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. | +| | `string` | | +| | `string` | The date/time the object was last updated. | +| | `object` | Reference to the user that last updated the object. | +| | `string` | Version of these Orchestration Rules | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_orch_path_unrouted` | `SELECT` | `id` | Get a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `_get_orch_path_unrouted` | `EXEC` | `id` | Get a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| -| `update_orch_path_unrouted` | `EXEC` | `id` | Update a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| +| | `SELECT` | | Get a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Get a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.read`
| +| | `EXEC` | | Update a Global Event Orchestration's Rules for Unrouted events.

An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service.

The Unrouted Orchestration evaluates Events sent to it against each of its rules, beginning with the rules in the "start" set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Unrouted Orchestration for further processing.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations)

Scoped OAuth requires: `event_orchestrations.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/extension_schemas/extension_schemas/index.md b/docs/pagerduty-docs/providers/pagerduty/extension_schemas/extension_schemas/index.md index 0f81d30133..e904899d5b 100644 --- a/docs/pagerduty-docs/providers/pagerduty/extension_schemas/extension_schemas/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/extension_schemas/extension_schemas/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameextension_schemas
TypeResource
Idpagerduty.extension_schemas.extension_schemas
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `description` | `string` | The long description for the Extension | -| `guide_url` | `string` | A link to the extension's support guide | -| `icon_url` | `string` | A small logo, 18-by-18 pixels. | -| `key` | `string` | Machine friendly display label | -| `label` | `string` | Human friendly display label | -| `logo_url` | `string` | A large logo, 75 pixels high and no more than 300 pixels wide. | -| `send_types` | `array` | The types of PagerDuty incident events that will activate this Extension | -| `url` | `string` | The url that the webhook payload will be sent to for this Extension. | +| | `string` | The long description for the Extension | +| | `string` | A link to the extension's support guide | +| | `string` | A small logo, 18-by-18 pixels. | +| | `string` | Machine friendly display label | +| | `string` | Human friendly display label | +| | `string` | A large logo, 75 pixels high and no more than 300 pixels wide. | +| | `array` | The types of PagerDuty incident events that will activate this Extension | +| | `string` | The url that the webhook payload will be sent to for this Extension. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_extension_schema` | `SELECT` | `id` | Get details about one specific extension vendor.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| -| `list_extension_schemas` | `SELECT` | | List all extension schemas.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| -| `_get_extension_schema` | `EXEC` | `id` | Get details about one specific extension vendor.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| -| `_list_extension_schemas` | `EXEC` | | List all extension schemas.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| +| | `SELECT` | | Get details about one specific extension vendor.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| +| | `SELECT` | | List all extension schemas.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| +| | `EXEC` | | Get details about one specific extension vendor.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| +| | `EXEC` | | List all extension schemas.

A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extension-schemas)

Scoped OAuth requires: `extension_schemas.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/extension_schemas/index.md b/docs/pagerduty-docs/providers/pagerduty/extension_schemas/index.md index 27f18d9a05..07d32ac051 100644 --- a/docs/pagerduty-docs/providers/pagerduty/extension_schemas/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/extension_schemas/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Extension Schemas :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/extensions/extensions/index.md b/docs/pagerduty-docs/providers/pagerduty/extensions/extensions/index.md index df5712f102..2b6d354028 100644 --- a/docs/pagerduty-docs/providers/pagerduty/extensions/extensions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/extensions/extensions/index.md @@ -14,39 +14,42 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameextensions
TypeResource
Idpagerduty.extensions.extensions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the extension. | -| `_type` | `string` | The type of object being created. | -| `config` | `object` | The object that contains extension configuration values depending on the extension schema specification. | -| `endpoint_url` | `string` | The url of the extension. | -| `extension_objects` | `array` | The objects for which the extension applies | -| `extension_schema` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `temporarily_disabled` | `boolean` | Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the extension. | +| | `string` | The type of object being created. | +| | `object` | The object that contains extension configuration values depending on the extension schema specification. | +| | `string` | The url of the extension. | +| | `array` | The objects for which the extension applies | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `boolean` | Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_extension` | `SELECT` | `id` | Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| -| `list_extensions` | `SELECT` | | List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| -| `create_extension` | `INSERT` | `data__extension` | Create a new Extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| -| `delete_extension` | `DELETE` | `id` | Delete an existing extension.

Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| -| `_get_extension` | `EXEC` | `id` | Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| -| `_list_extensions` | `EXEC` | | List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| -| `enable_extension` | `EXEC` | `id` | Enable an extension that is temporarily disabled. (This API does not require a request body.)

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| -| `update_extension` | `EXEC` | `id, data__extension` | Update an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| +| | `SELECT` | | Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| +| | `SELECT` | | List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| +| | `INSERT` | | Create a new Extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| +| | `DELETE` | | Delete an existing extension.

Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| +| | `EXEC` | | Get details about an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| +| | `EXEC` | | List existing extensions.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.read`
| +| | `EXEC` | | Enable an extension that is temporarily disabled. (This API does not require a request body.)

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| +| | `EXEC` | | Update an existing extension.

Extensions are representations of Extension Schema objects that are attached to Services.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#extensions)

Scoped OAuth requires: `extensions.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/extensions/index.md b/docs/pagerduty-docs/providers/pagerduty/extensions/index.md index 285be7fa50..7faa683a58 100644 --- a/docs/pagerduty-docs/providers/pagerduty/extensions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/extensions/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Extensions Are Representations Of Extension Schema Objects That Are Attached To Services. diff --git a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/actions/index.md b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/actions/index.md index 2818d2256a..90b1987ccc 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/actions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/actions/index.md @@ -14,44 +14,47 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactions
TypeResource
Idpagerduty.incident_workflows.actions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The descriptive name of the Action | -| `description` | `string` | A description of the Action | -| `_type` | `string` | | -| `action_type` | `string` | The type of Action | -| `created_at` | `string` | The date-time at which this Action was created | -| `created_by_user_id` | `string` | The obfuscated Id of the User who created this Action | -| `domain_name` | `string` | The Verified Domain of the account that created the action | -| `function_name` | `string` | The Function Name describing the specific functionality of the Action | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `inputs` | `array` | Inputs whose values used during Action execution | -| `metadata` | `string` | JSON-formatted string of metadata pertaining to the Action | -| `outputs` | `array` | Outputs whose values set during Action execution | -| `package_name` | `string` | The Package Name corresponding to the broad category of the Action | -| `search_keywords` | `array` | A set of search keywords to apply to this action. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `tags` | `array` | A set of tags to apply to this action. | -| `trigger_type` | `string` | The type of Trigger this Action is, if action_type is trigger | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `version` | `number` | The version of the Action | +| | `string` | | +| | `string` | The descriptive name of the Action | +| | `string` | A description of the Action | +| | `string` | | +| | `string` | The type of Action | +| | `string` | The date-time at which this Action was created | +| | `string` | The obfuscated Id of the User who created this Action | +| | `string` | The Verified Domain of the account that created the action | +| | `string` | The Function Name describing the specific functionality of the Action | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `array` | Inputs whose values used during Action execution | +| | `string` | JSON-formatted string of metadata pertaining to the Action | +| | `array` | Outputs whose values set during Action execution | +| | `string` | The Package Name corresponding to the broad category of the Action | +| | `array` | A set of search keywords to apply to this action. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | A set of tags to apply to this action. | +| | `string` | The type of Trigger this Action is, if action_type is trigger | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `number` | The version of the Action | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_workflow_action` | `SELECT` | `id` | Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
| -| `list_incident_workflow_actions` | `SELECT` | | List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
| -| `_get_incident_workflow_action` | `EXEC` | `id` | Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
| -| `_list_incident_workflow_actions` | `EXEC` | | List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
| +| | `SELECT` | | Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
| +| | `SELECT` | | List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | Get an Incident Workflow Action

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | List Incident Workflow Actions

Scoped OAuth requires: `incident_workflows.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/incident_workflows/index.md b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/incident_workflows/index.md index 8a6bc6347b..2fb9b9f775 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/incident_workflows/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/incident_workflows/index.md @@ -14,38 +14,41 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_workflows
TypeResource
Idpagerduty.incident_workflows.incident_workflows
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | A descriptive name for the Incident Workflow | -| `description` | `string` | A description of what the Incident Workflow does | -| `_type` | `string` | | -| `created_at` | `string` | The timestamp this Incident Workflow was created | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `steps` | `array` | The ordered list of steps that execute sequentially as part of the workflow | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `team` | `object` | If specified then workflow edit permissions will be scoped to members of this team | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | A descriptive name for the Incident Workflow | +| | `string` | A description of what the Incident Workflow does | +| | `string` | | +| | `string` | The timestamp this Incident Workflow was created | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `array` | The ordered list of steps that execute sequentially as part of the workflow | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `object` | If specified then workflow edit permissions will be scoped to members of this team | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_workflow` | `SELECT` | `id` | Get an existing Incident Workflow
An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| -| `list_incident_workflows` | `SELECT` | | List existing Incident Workflows.

This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint.

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| -| `create_incident_workflow_instance` | `INSERT` | `id, data__incident_workflow_instance` | Start an Instance of an Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows:instances.write`
| -| `delete_incident_workflow` | `DELETE` | `id` | Delete an existing Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| -| `_get_incident_workflow` | `EXEC` | `id` | Get an existing Incident Workflow
An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| -| `_list_incident_workflows` | `EXEC` | | List existing Incident Workflows.

This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint.

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| -| `post_incident_workflow` | `EXEC` | `data__incident_workflow` | Create a new Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| -| `put_incident_workflow` | `EXEC` | `id, data__incident_workflow` | Update an Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| +| | `SELECT` | | Get an existing Incident Workflow
An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| +| | `SELECT` | | List existing Incident Workflows.

This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint.

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| +| | `INSERT` | | Start an Instance of an Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows:instances.write`
| +| | `DELETE` | | Delete an existing Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| +| | `EXEC` | | Get an existing Incident Workflow
An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | List existing Incident Workflows.

This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint.

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | Create a new Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| +| | `EXEC` | | Update an Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: `incident_workflows.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/index.md b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/index.md index 15bdf8a33f..e4f3edf4c8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Incident Workflows :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/triggers/index.md b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/triggers/index.md index 8809d3837b..051736a3a2 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incident_workflows/triggers/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incident_workflows/triggers/index.md @@ -14,42 +14,45 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametriggers
TypeResource
Idpagerduty.incident_workflows.triggers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | | -| `condition` | `string` | A PCL condition string.

If specified, the trigger will execute when the condition is met on an incident.

If unspecified, the trigger will execute on incident creation.

Required if trigger_type is “conditional”, not allowed if trigger_type is “manual”.
| -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `is_subscribed_to_all_services` | `boolean` | Indicates that the Trigger should be associated with All Services | -| `permissions` | `object` | An object detailing who can start this Trigger. Applicable only to manual Triggers. | -| `self` | `string` | the API show URL at which the object is accessible | -| `services` | `array` | An optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `trigger_type` | `string` | | -| `trigger_type_name` | `string` | Human readable name for the trigger type | -| `trigger_url` | `string` | | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `workflow` | `object` | Workflow to start when this trigger is invoked | +| | `string` | | +| | `string` | | +| | `string` | A PCL condition string.

If specified, the trigger will execute when the condition is met on an incident.

If unspecified, the trigger will execute on incident creation.

Required if trigger_type is “conditional”, not allowed if trigger_type is “manual”.
| +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `boolean` | Indicates that the Trigger should be associated with All Services | +| | `object` | An object detailing who can start this Trigger. Applicable only to manual Triggers. | +| | `string` | the API show URL at which the object is accessible | +| | `array` | An optional array of Services associated with this workflow. Incidents in any of the listed Services are eligible to fire this Trigger | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | | +| | `string` | Human readable name for the trigger type | +| | `string` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `object` | Workflow to start when this trigger is invoked | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_workflow_trigger` | `SELECT` | `id` | Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
| -| `list_incident_workflow_triggers` | `SELECT` | | List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
| -| `create_incident_workflow_trigger` | `INSERT` | `data__trigger` | Create new Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| -| `delete_incident_workflow_trigger` | `DELETE` | `id` | Delete an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| -| `delete_service_from_incident_workflow_trigger` | `DELETE` | `service_id, trigger_id` | Remove a an existing Service from an Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| -| `_get_incident_workflow_trigger` | `EXEC` | `id` | Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
| -| `_list_incident_workflow_triggers` | `EXEC` | | List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
| -| `associate_service_to_incident_workflow_trigger` | `EXEC` | `id, data__service` | Associate a Service with an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| -| `update_incident_workflow_trigger` | `EXEC` | `id, data__trigger` | Update an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| +| | `SELECT` | | Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
| +| | `SELECT` | | List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
| +| | `INSERT` | | Create new Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| +| | `DELETE` | | Delete an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| +| | `DELETE` | | Remove a an existing Service from an Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| +| | `EXEC` | | Retrieve an existing Incident Workflows Trigger

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | List existing Incident Workflow Triggers

Scoped OAuth requires: `incident_workflows.read`
| +| | `EXEC` | | Associate a Service with an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| +| | `EXEC` | | Update an existing Incident Workflow Trigger

Scoped OAuth requires: `incident_workflows.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/alerts/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/alerts/index.md index a747b3df48..1b3d993cad 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/alerts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/alerts/index.md @@ -14,41 +14,44 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namealerts
TypeResource
Idpagerduty.incidents.alerts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | The type of object being created. | -| `alert_key` | `string` | The alert's de-duplication key. | -| `body` | `object` | A JSON object containing data describing the alert. | -| `created_at` | `string` | The date/time the alert was first triggered. | -| `first_trigger_log_entry` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `incident` | `object` | | -| `integration` | `object` | | -| `self` | `string` | the API show URL at which the object is accessible | -| `service` | `object` | | -| `severity` | `string` | The magnitude of the problem as reported by the monitoring tool. | -| `status` | `string` | The current status of the alert. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `suppressed` | `boolean` | Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The type of object being created. | +| | `string` | The alert's de-duplication key. | +| | `object` | A JSON object containing data describing the alert. | +| | `string` | The date/time the alert was first triggered. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `object` | | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | The magnitude of the problem as reported by the monitoring tool. | +| | `string` | The current status of the alert. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `boolean` | Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_alert` | `SELECT` | `alert_id, id` | Show detailed information about an alert. Accepts an alert id.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `list_incident_alerts` | `SELECT` | `id` | List alerts for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `_get_incident_alert` | `EXEC` | `alert_id, id` | Show detailed information about an alert. Accepts an alert id.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `_list_incident_alerts` | `EXEC` | `id` | List alerts for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `update_incident_alert` | `EXEC` | `From, alert_id, id, data__alert` | Resolve an alert or associate an alert with a new parent incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `update_incident_alerts` | `EXEC` | `From, id, data__alerts` | Resolve multiple alerts or associate them with different incidents.

An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue.

A maximum of 500 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `SELECT` | | Show detailed information about an alert. Accepts an alert id.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `SELECT` | | List alerts for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | Show detailed information about an alert. Accepts an alert id.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | List alerts for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | Resolve an alert or associate an alert with a new parent incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Resolve multiple alerts or associate them with different incidents.

An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue.

A maximum of 500 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/business_services_impacts/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/business_services_impacts/index.md index c2a76604b7..b9e75eccaf 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/business_services_impacts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/business_services_impacts/index.md @@ -14,27 +14,30 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebusiness_services_impacts
TypeResource
Idpagerduty.incidents.business_services_impacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `additional_fields` | `object` | | -| `status` | `string` | The current impact status of the object | -| `type` | `string` | The kind of object that has been impacted | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | The current impact status of the object | +| | `string` | The kind of object that has been impacted | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_impacted_business_services` | `SELECT` | `X-EARLY-ACCESS, id` | Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `_get_incident_impacted_business_services` | `EXEC` | `X-EARLY-ACCESS, id` | Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `put_incident_manual_business_service_association` | `EXEC` | `X-EARLY-ACCESS, business_service_id, id, data__relation` | Change Impact of an Incident on a Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `SELECT` | | Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Retrieve a list of Business Services that are being impacted by the given Incident.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Change Impact of an Incident on a Business Service.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/field_values/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/field_values/index.md index ffa9b2f3d1..acfb1028b7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/field_values/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/field_values/index.md @@ -14,31 +14,34 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefield_values
TypeResource
Idpagerduty.incidents.field_values
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Id of the field. | -| `name` | `string` | The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique. | -| `description` | `string` | A description of the data this field contains. | -| `datatype` | `string` | The kind of data the custom field is allowed to contain. | -| `display_name` | `string` | The human-readable name of the field. This must be unique across an account. | -| `fixed_options` | `boolean` | If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime" | -| `multi_value` | `boolean` | If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url" | -| `type` | `string` | Determines the type of the reference. | -| `value` | `` | | +| | `string` | Id of the field. | +| | `string` | The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique. | +| | `string` | A description of the data this field contains. | +| | `string` | The kind of data the custom field is allowed to contain. | +| | `string` | The human-readable name of the field. This must be unique across an account. | +| | `boolean` | If `true`, restricts the values allowed to be stored in the custom field to a limited set of options (configured via the Field Option sub-resource). Must be `false` if `datatype` is "boolean", "url", or "datetime" | +| | `boolean` | If `true`, allows the custom field to store a set of multiple values. Must be `false` if `datatype` is not "string" or "url" | +| | `string` | Determines the type of the reference. | +| | `` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_field_values` | `SELECT` | `X-EARLY-ACCESS, id` | Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `_get_incident_field_values` | `EXEC` | `X-EARLY-ACCESS, id` | Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| -| `set_incident_field_values` | `EXEC` | `id, data__field_values` | Set field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `SELECT` | | Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Get field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| +| | `EXEC` | | Set field values for an incident

<!-- theme: warning -->

> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/field_values_schema/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/field_values_schema/index.md index cf223cd73b..84578671f7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/field_values_schema/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/field_values_schema/index.md @@ -14,28 +14,31 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefield_values_schema
TypeResource
Idpagerduty.incidents.field_values_schema
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the resource. | -| `description` | `string` | A description of this schema. | -| `field_configurations` | `array` | | -| `self` | `string` | The API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `title` | `string` | The name of the schema. | -| `type` | `string` | | +| | `string` | The ID of the resource. | +| | `string` | A description of this schema. | +| | `array` | | +| | `string` | The API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The name of the schema. | +| | `string` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_schema_for_incident` | `SELECT` | `X-EARLY-ACCESS, id` | -| `_get_schema_for_incident` | `EXEC` | `X-EARLY-ACCESS, id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/incidents/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/incidents/index.md index 10dc69eed8..ad1e9e6211 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/incidents/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/incidents/index.md @@ -14,59 +14,62 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincidents
TypeResource
Idpagerduty.incidents.incidents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `acknowledgements` | `array` | List of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`. | -| `alert_counts` | `object` | | -| `assigned_via` | `string` | How the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy` | -| `assignments` | `array` | List of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`. | -| `body` | `object` | | -| `conference_bridge` | `object` | | -| `created_at` | `string` | The date/time the incident was first triggered. | -| `escalation_policy` | `object` | | -| `first_trigger_log_entry` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `incident_key` | `string` | The incident's de-duplication key. | -| `incident_number` | `integer` | The number of the incident. This is unique across your account. | -| `incidents_responders` | `array` | | -| `last_status_change_at` | `string` | The time at which the status of the incident last changed. | -| `last_status_change_by` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `pending_actions` | `array` | The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to. | -| `priority` | `object` | | -| `resolve_reason` | `object` | | -| `responder_requests` | `array` | | -| `self` | `string` | the API show URL at which the object is accessible | -| `service` | `object` | | -| `status` | `string` | The current status of the incident. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | The teams involved in the incident’s lifecycle. | -| `title` | `string` | A succinct description of the nature, symptoms, cause, or effect of the incident. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `urgency` | `string` | The current urgency of the incident. | +| | `string` | | +| | `array` | List of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`. | +| | `object` | | +| | `string` | How the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy` | +| | `array` | List of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`. | +| | `object` | | +| | `object` | | +| | `string` | The date/time the incident was first triggered. | +| | `object` | | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | The incident's de-duplication key. | +| | `integer` | The number of the incident. This is unique across your account. | +| | `array` | | +| | `string` | The time at which the status of the incident last changed. | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to. | +| | `object` | | +| | `object` | | +| | `array` | | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | The current status of the incident. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | The teams involved in the incident’s lifecycle. | +| | `string` | A succinct description of the nature, symptoms, cause, or effect of the incident. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | The current urgency of the incident. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident` | `SELECT` | `X-EARLY-ACCESS, id` | Show detailed information about an incident. Accepts either an incident id, or an incident number.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
| -| `list_incidents` | `SELECT` | | List existing incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `create_incident` | `INSERT` | `From, data__incident` | Create an incident synchronously without a corresponding event from a monitoring service.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `_get_incident` | `EXEC` | `X-EARLY-ACCESS, id` | Show detailed information about an incident. Accepts either an incident id, or an incident number.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
| -| `_list_incidents` | `EXEC` | | List existing incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `create_incident_responder_request` | `EXEC` | `From, id, data__message, data__requester_id, data__responder_request_targets` | Send a new responder request for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `create_incident_snooze` | `EXEC` | `From, id, data__duration` | Snooze an incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `create_incident_status_update` | `EXEC` | `From, id, data__message` | Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `merge_incidents` | `EXEC` | `From, id, data__source_incidents` | Merge a list of source incidents into this incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `remove_incident_notification_subscribers` | `EXEC` | `id, data__subscribers` | Unsubscribes the matching Subscribers from Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
| -| `update_incident` | `EXEC` | `From, id, data__incident` | Acknowledge, resolve, escalate or reassign an incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `update_incidents` | `EXEC` | `From, data__incidents` | Acknowledge, resolve, escalate or reassign one or more incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large).

Note: the manage incidents API endpoint is rate limited to 500 requests per minute.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `SELECT` | | Show detailed information about an incident. Accepts either an incident id, or an incident number.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
| +| | `SELECT` | | List existing incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `INSERT` | | Create an incident synchronously without a corresponding event from a monitoring service.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Show detailed information about an incident. Accepts either an incident id, or an incident number.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

<!-- theme: warning -->
> ### Early Access
> The `include[]=field_values` part of this endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | List existing incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | Send a new responder request for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Snooze an incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Merge a list of source incidents into this incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Unsubscribes the matching Subscribers from Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Acknowledge, resolve, escalate or reassign an incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | Acknowledge, resolve, escalate or reassign one or more incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large).

Note: the manage incidents API endpoint is rate limited to 500 requests per minute.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/index.md index 8dd9f002ff..5a641375a6 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + An Incident Represents A Problem Or An Issue That Needs To Be Addressed And Resolved. Incidents Trigger On A Service, Which Prompts Notifications To Go Out To On-Call Responders Per The Service'S Escalation Policy. diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/log_entries/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/log_entries/index.md index cc6e2eadab..4cc8ac4f19 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/log_entries/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/log_entries/index.md @@ -14,253 +14,256 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_entries
TypeResource
Idpagerduty.incidents.log_entries
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `AnnotateLogEntry__type` | `string` | | -| `AnnotateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `AnnotateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `AnnotateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `AnnotateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `AnnotateLogEntry_event_details` | `object` | | -| `AnnotateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `AnnotateLogEntry_id` | `string` | | -| `AnnotateLogEntry_incident` | `object` | | -| `AnnotateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `AnnotateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `AnnotateLogEntry_service` | `object` | | -| `AnnotateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `AnnotateLogEntry_teams` | `array` | Will consist of references unless included | -| `AnnotateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `AssignLogEntry__type` | `string` | | -| `AssignLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `AssignLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `AssignLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `AssignLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `AssignLogEntry_event_details` | `object` | | -| `AssignLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `AssignLogEntry_id` | `string` | | -| `AssignLogEntry_incident` | `object` | | -| `AssignLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `AssignLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `AssignLogEntry_service` | `object` | | -| `AssignLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `AssignLogEntry_teams` | `array` | Will consist of references unless included | -| `AssignLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `DelegateLogEntry__type` | `string` | | -| `DelegateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `DelegateLogEntry_assignees` | `array` | An array of assigned Users for this log entry | -| `DelegateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `DelegateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `DelegateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `DelegateLogEntry_event_details` | `object` | | -| `DelegateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `DelegateLogEntry_id` | `string` | | -| `DelegateLogEntry_incident` | `object` | | -| `DelegateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `DelegateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `DelegateLogEntry_service` | `object` | | -| `DelegateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `DelegateLogEntry_teams` | `array` | Will consist of references unless included | -| `DelegateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `EscalateLogEntry__type` | `string` | | -| `EscalateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `EscalateLogEntry_assignees` | `array` | An array of assigned Users for this log entry | -| `EscalateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `EscalateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `EscalateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `EscalateLogEntry_event_details` | `object` | | -| `EscalateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `EscalateLogEntry_id` | `string` | | -| `EscalateLogEntry_incident` | `object` | | -| `EscalateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `EscalateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `EscalateLogEntry_service` | `object` | | -| `EscalateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `EscalateLogEntry_teams` | `array` | Will consist of references unless included | -| `EscalateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ExhaustEscalationPathLogEntry__type` | `string` | | -| `ExhaustEscalationPathLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ExhaustEscalationPathLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ExhaustEscalationPathLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ExhaustEscalationPathLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ExhaustEscalationPathLogEntry_event_details` | `object` | | -| `ExhaustEscalationPathLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ExhaustEscalationPathLogEntry_id` | `string` | | -| `ExhaustEscalationPathLogEntry_incident` | `object` | | -| `ExhaustEscalationPathLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ExhaustEscalationPathLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ExhaustEscalationPathLogEntry_service` | `object` | | -| `ExhaustEscalationPathLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ExhaustEscalationPathLogEntry_teams` | `array` | Will consist of references unless included | -| `ExhaustEscalationPathLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `NotifyLogEntry__type` | `string` | | -| `NotifyLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `NotifyLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `NotifyLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `NotifyLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `NotifyLogEntry_event_details` | `object` | | -| `NotifyLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `NotifyLogEntry_id` | `string` | | -| `NotifyLogEntry_incident` | `object` | | -| `NotifyLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `NotifyLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `NotifyLogEntry_service` | `object` | | -| `NotifyLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `NotifyLogEntry_teams` | `array` | Will consist of references unless included | -| `NotifyLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ReachAckLimitLogEntry__type` | `string` | | -| `ReachAckLimitLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ReachAckLimitLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ReachAckLimitLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ReachAckLimitLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ReachAckLimitLogEntry_event_details` | `object` | | -| `ReachAckLimitLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ReachAckLimitLogEntry_id` | `string` | | -| `ReachAckLimitLogEntry_incident` | `object` | | -| `ReachAckLimitLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ReachAckLimitLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ReachAckLimitLogEntry_service` | `object` | | -| `ReachAckLimitLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ReachAckLimitLogEntry_teams` | `array` | Will consist of references unless included | -| `ReachAckLimitLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ReachTriggerLimitLogEntry__type` | `string` | | -| `ReachTriggerLimitLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ReachTriggerLimitLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ReachTriggerLimitLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ReachTriggerLimitLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ReachTriggerLimitLogEntry_event_details` | `object` | | -| `ReachTriggerLimitLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ReachTriggerLimitLogEntry_id` | `string` | | -| `ReachTriggerLimitLogEntry_incident` | `object` | | -| `ReachTriggerLimitLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ReachTriggerLimitLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ReachTriggerLimitLogEntry_service` | `object` | | -| `ReachTriggerLimitLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ReachTriggerLimitLogEntry_teams` | `array` | Will consist of references unless included | -| `ReachTriggerLimitLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `RepeatEscalationPathLogEntry__type` | `string` | | -| `RepeatEscalationPathLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `RepeatEscalationPathLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `RepeatEscalationPathLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `RepeatEscalationPathLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `RepeatEscalationPathLogEntry_event_details` | `object` | | -| `RepeatEscalationPathLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `RepeatEscalationPathLogEntry_id` | `string` | | -| `RepeatEscalationPathLogEntry_incident` | `object` | | -| `RepeatEscalationPathLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `RepeatEscalationPathLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `RepeatEscalationPathLogEntry_service` | `object` | | -| `RepeatEscalationPathLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `RepeatEscalationPathLogEntry_teams` | `array` | Will consist of references unless included | -| `RepeatEscalationPathLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ResolveLogEntry__type` | `string` | | -| `ResolveLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ResolveLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ResolveLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ResolveLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ResolveLogEntry_event_details` | `object` | | -| `ResolveLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ResolveLogEntry_id` | `string` | | -| `ResolveLogEntry_incident` | `object` | | -| `ResolveLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ResolveLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ResolveLogEntry_service` | `object` | | -| `ResolveLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ResolveLogEntry_teams` | `array` | Will consist of references unless included | -| `ResolveLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `SnoozeLogEntry__type` | `string` | | -| `SnoozeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `SnoozeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `SnoozeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `SnoozeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `SnoozeLogEntry_event_details` | `object` | | -| `SnoozeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `SnoozeLogEntry_id` | `string` | | -| `SnoozeLogEntry_incident` | `object` | | -| `SnoozeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `SnoozeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `SnoozeLogEntry_service` | `object` | | -| `SnoozeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `SnoozeLogEntry_teams` | `array` | Will consist of references unless included | -| `SnoozeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `TriggerLogEntry__type` | `string` | | -| `TriggerLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `TriggerLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `TriggerLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `TriggerLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `TriggerLogEntry_event_details` | `object` | | -| `TriggerLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `TriggerLogEntry_id` | `string` | | -| `TriggerLogEntry_incident` | `object` | | -| `TriggerLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `TriggerLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `TriggerLogEntry_service` | `object` | | -| `TriggerLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `TriggerLogEntry_teams` | `array` | Will consist of references unless included | -| `TriggerLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `UnacknowledgeLogEntry__type` | `string` | | -| `UnacknowledgeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `UnacknowledgeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `UnacknowledgeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `UnacknowledgeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `UnacknowledgeLogEntry_event_details` | `object` | | -| `UnacknowledgeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `UnacknowledgeLogEntry_id` | `string` | | -| `UnacknowledgeLogEntry_incident` | `object` | | -| `UnacknowledgeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `UnacknowledgeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `UnacknowledgeLogEntry_service` | `object` | | -| `UnacknowledgeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `UnacknowledgeLogEntry_teams` | `array` | Will consist of references unless included | -| `UnacknowledgeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `UrgencyChangeLogEntry__type` | `string` | | -| `UrgencyChangeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `UrgencyChangeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `UrgencyChangeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `UrgencyChangeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `UrgencyChangeLogEntry_event_details` | `object` | | -| `UrgencyChangeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `UrgencyChangeLogEntry_id` | `string` | | -| `UrgencyChangeLogEntry_incident` | `object` | | -| `UrgencyChangeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `UrgencyChangeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `UrgencyChangeLogEntry_service` | `object` | | -| `UrgencyChangeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `UrgencyChangeLogEntry_teams` | `array` | Will consist of references unless included | -| `UrgencyChangeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `_created_at` | `string` | Time at which the log entry was created | -| `_type` | `string` | | -| `acknowledgement_timeout` | `integer` | Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set. | -| `agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `assignees` | `array` | An array of assigned Users for this log entry | -| `changed_actions` | `array` | | -| `channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `created_at` | `string` | Time at which the log entry was created. | -| `event_details` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `incident` | `object` | | -| `note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `self` | `string` | the API show URL at which the object is accessible | -| `service` | `object` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | Will consist of references unless included | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `user` | `object` | | +| | `string` | | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | Time at which the log entry was created | +| | `string` | | +| | `integer` | Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set. | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `array` | | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_incident_log_entries` | `SELECT` | `id` | -| `_list_incident_log_entries` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/notes/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/notes/index.md index 24a6693894..269c4a3143 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/notes/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/notes/index.md @@ -14,27 +14,30 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotes
TypeResource
Idpagerduty.incidents.notes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `channel` | `object` | The means by which this Note was created. Has different formats depending on type. | -| `content` | `string` | The note content | -| `created_at` | `string` | The time at which the note was submitted | -| `user` | `object` | The user who created a Note. If a service created this Note the `user.type` will be "bot_user_reference" and `user.summary` will list the name of the service rather than the user. | +| | `string` | | +| | `object` | The means by which this Note was created. Has different formats depending on type. | +| | `string` | The note content | +| | `string` | The time at which the note was submitted | +| | `object` | The user who created a Note. If a service created this Note the `user.type` will be "bot_user_reference" and `user.summary` will list the name of the service rather than the user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_incident_notes` | `SELECT` | `id` | List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| -| `create_incident_note` | `INSERT` | `From, id, data__note` | Create a new note for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 2000 notes can be added to an incident.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| -| `_list_incident_notes` | `EXEC` | `id` | List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `SELECT` | | List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| +| | `INSERT` | | Create a new note for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 2000 notes can be added to an incident.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.write`
| +| | `EXEC` | | List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)

Scoped OAuth requires: `incidents.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/outlier_incident/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/outlier_incident/index.md index 9dfa3b9043..0bb4b4eefb 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/outlier_incident/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/outlier_incident/index.md @@ -14,23 +14,26 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoutlier_incident
TypeResource
Idpagerduty.incidents.outlier_incident
Id
## Fields | Name | Datatype | |:-----|:---------| -| `incident` | `object` | -| `incident_template` | `object` | +| | `object` | +| | `object` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_outlier_incident` | `SELECT` | `id` | -| `_get_outlier_incident` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/past_incidents/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/past_incidents/index.md index b26d258316..3c46fb119e 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/past_incidents/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/past_incidents/index.md @@ -14,23 +14,26 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepast_incidents
TypeResource
Idpagerduty.incidents.past_incidents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `incident` | `object` | Incident model reference | -| `score` | `number` | The computed similarity score associated with the incident and parent incident | +| | `object` | Incident model reference | +| | `number` | The computed similarity score associated with the incident and parent incident | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_past_incidents` | `SELECT` | `id` | -| `_get_past_incidents` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/related_incidents/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/related_incidents/index.md index c1fb53929e..c6a4b70919 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/related_incidents/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/related_incidents/index.md @@ -14,23 +14,26 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerelated_incidents
TypeResource
Idpagerduty.incidents.related_incidents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `incident_details` | `object` | | -| `relationship_details` | `array` | A list of reasons for why the Incident is considered related. | +| | `object` | | +| | `array` | A list of reasons for why the Incident is considered related. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_related_incidents` | `SELECT` | `id` | -| `_get_related_incidents` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/incidents/status_updates_subscribers/index.md b/docs/pagerduty-docs/providers/pagerduty/incidents/status_updates_subscribers/index.md index 518a7cb2d0..d2072fb90b 100644 --- a/docs/pagerduty-docs/providers/pagerduty/incidents/status_updates_subscribers/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/incidents/status_updates_subscribers/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus_updates_subscribers
TypeResource
Idpagerduty.incidents.status_updates_subscribers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `has_indirect_subscription` | `boolean` | If this subcriber has an indirect subscription to this incident via another object | -| `subscribed_via` | `array` | | -| `subscriber_id` | `string` | The ID of the entity being subscribed | -| `subscriber_type` | `string` | The type of the entity being subscribed | +| | `boolean` | If this subcriber has an indirect subscription to this incident via another object | +| | `array` | | +| | `string` | The ID of the entity being subscribed | +| | `string` | The type of the entity being subscribed | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_notification_subscribers` | `SELECT` | `id` | Retrieve a list of Notification Subscribers on the Incident.

<!-- theme: warning -->
> Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| -| `create_incident_notification_subscribers` | `INSERT` | `id, data__subscribers` | Subscribe the given entities to Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
| -| `_get_incident_notification_subscribers` | `EXEC` | `id` | Retrieve a list of Notification Subscribers on the Incident.

<!-- theme: warning -->
> Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| +| | `SELECT` | | Retrieve a list of Notification Subscribers on the Incident.

<!-- theme: warning -->
> Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| +| | `INSERT` | | Subscribe the given entities to Incident Status Update Notifications.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Retrieve a list of Notification Subscribers on the Incident.

<!-- theme: warning -->
> Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint.
Scoped OAuth requires: `subscribers.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/licenses/index.md b/docs/pagerduty-docs/providers/pagerduty/licenses/index.md index fd2d722cad..73702b4a3a 100644 --- a/docs/pagerduty-docs/providers/pagerduty/licenses/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/licenses/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Licenses Are Allocated To Users To Allow For Per-User Access To PagerDuty Functionality Within An Account. diff --git a/docs/pagerduty-docs/providers/pagerduty/licenses/license_allocations/index.md b/docs/pagerduty-docs/providers/pagerduty/licenses/license_allocations/index.md index b196e3649c..a79bbea3b7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/licenses/license_allocations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/licenses/license_allocations/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelicense_allocations
TypeResource
Idpagerduty.licenses.license_allocations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `allocated_at` | `string` | Indicates the date and time the License was allocated to the User | -| `license` | `object` | | -| `user` | `object` | | +| | `string` | Indicates the date and time the License was allocated to the User | +| | `object` | | +| | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_license_allocations` | `SELECT` | | -| `_list_license_allocations` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/licenses/licenses/index.md b/docs/pagerduty-docs/providers/pagerduty/licenses/licenses/index.md index 778c29507f..7ec019fba1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/licenses/licenses/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/licenses/licenses/index.md @@ -14,32 +14,35 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelicenses
TypeResource
Idpagerduty.licenses.licenses
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Uniquely identifies the resource | -| `name` | `string` | Name of the License.
| -| `description` | `string` | Description of the License. May include the names of add-ons associated with
the License, if there are any.
| -| `allocations_available` | `integer` | How many of these licenses are available to be allocated to a user. If this
value is "null" then there is no limit on the number of allocations allowed.
| -| `current_value` | `integer` | How many of these Licenses are currently allocated to Users | -| `html_url` | `string` | HTML URL to access the License | -| `role_group` | `string` | Indicates whether this License is assignable to full or stakeholder Users | -| `self` | `string` | API URL to access the License | -| `summary` | `string` | Summary of the License | -| `type` | `string` | Type of object | -| `valid_roles` | `array` | The roles a User with this License can have | +| | `string` | Uniquely identifies the resource | +| | `string` | Name of the License.
| +| | `string` | Description of the License. May include the names of add-ons associated with
the License, if there are any.
| +| | `integer` | How many of these licenses are available to be allocated to a user. If this
value is "null" then there is no limit on the number of allocations allowed.
| +| | `integer` | How many of these Licenses are currently allocated to Users | +| | `string` | HTML URL to access the License | +| | `string` | Indicates whether this License is assignable to full or stakeholder Users | +| | `string` | API URL to access the License | +| | `string` | Summary of the License | +| | `string` | Type of object | +| | `array` | The roles a User with this License can have | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_licenses` | `SELECT` | | -| `_list_licenses` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/log_entries/index.md b/docs/pagerduty-docs/providers/pagerduty/log_entries/index.md index 01d1f0b2ed..4cb58b7bac 100644 --- a/docs/pagerduty-docs/providers/pagerduty/log_entries/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/log_entries/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Log Entries :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/log_entries/log_entries/index.md b/docs/pagerduty-docs/providers/pagerduty/log_entries/log_entries/index.md index d3682618b1..1de1443296 100644 --- a/docs/pagerduty-docs/providers/pagerduty/log_entries/log_entries/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/log_entries/log_entries/index.md @@ -14,256 +14,259 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_entries
TypeResource
Idpagerduty.log_entries.log_entries
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `AnnotateLogEntry__type` | `string` | | -| `AnnotateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `AnnotateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `AnnotateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `AnnotateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `AnnotateLogEntry_event_details` | `object` | | -| `AnnotateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `AnnotateLogEntry_id` | `string` | | -| `AnnotateLogEntry_incident` | `object` | | -| `AnnotateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `AnnotateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `AnnotateLogEntry_service` | `object` | | -| `AnnotateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `AnnotateLogEntry_teams` | `array` | Will consist of references unless included | -| `AnnotateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `AssignLogEntry__type` | `string` | | -| `AssignLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `AssignLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `AssignLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `AssignLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `AssignLogEntry_event_details` | `object` | | -| `AssignLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `AssignLogEntry_id` | `string` | | -| `AssignLogEntry_incident` | `object` | | -| `AssignLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `AssignLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `AssignLogEntry_service` | `object` | | -| `AssignLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `AssignLogEntry_teams` | `array` | Will consist of references unless included | -| `AssignLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `DelegateLogEntry__type` | `string` | | -| `DelegateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `DelegateLogEntry_assignees` | `array` | An array of assigned Users for this log entry | -| `DelegateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `DelegateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `DelegateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `DelegateLogEntry_event_details` | `object` | | -| `DelegateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `DelegateLogEntry_id` | `string` | | -| `DelegateLogEntry_incident` | `object` | | -| `DelegateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `DelegateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `DelegateLogEntry_service` | `object` | | -| `DelegateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `DelegateLogEntry_teams` | `array` | Will consist of references unless included | -| `DelegateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `EscalateLogEntry__type` | `string` | | -| `EscalateLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `EscalateLogEntry_assignees` | `array` | An array of assigned Users for this log entry | -| `EscalateLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `EscalateLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `EscalateLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `EscalateLogEntry_event_details` | `object` | | -| `EscalateLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `EscalateLogEntry_id` | `string` | | -| `EscalateLogEntry_incident` | `object` | | -| `EscalateLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `EscalateLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `EscalateLogEntry_service` | `object` | | -| `EscalateLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `EscalateLogEntry_teams` | `array` | Will consist of references unless included | -| `EscalateLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ExhaustEscalationPathLogEntry__type` | `string` | | -| `ExhaustEscalationPathLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ExhaustEscalationPathLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ExhaustEscalationPathLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ExhaustEscalationPathLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ExhaustEscalationPathLogEntry_event_details` | `object` | | -| `ExhaustEscalationPathLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ExhaustEscalationPathLogEntry_id` | `string` | | -| `ExhaustEscalationPathLogEntry_incident` | `object` | | -| `ExhaustEscalationPathLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ExhaustEscalationPathLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ExhaustEscalationPathLogEntry_service` | `object` | | -| `ExhaustEscalationPathLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ExhaustEscalationPathLogEntry_teams` | `array` | Will consist of references unless included | -| `ExhaustEscalationPathLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `NotifyLogEntry__type` | `string` | | -| `NotifyLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `NotifyLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `NotifyLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `NotifyLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `NotifyLogEntry_event_details` | `object` | | -| `NotifyLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `NotifyLogEntry_id` | `string` | | -| `NotifyLogEntry_incident` | `object` | | -| `NotifyLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `NotifyLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `NotifyLogEntry_service` | `object` | | -| `NotifyLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `NotifyLogEntry_teams` | `array` | Will consist of references unless included | -| `NotifyLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ReachAckLimitLogEntry__type` | `string` | | -| `ReachAckLimitLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ReachAckLimitLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ReachAckLimitLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ReachAckLimitLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ReachAckLimitLogEntry_event_details` | `object` | | -| `ReachAckLimitLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ReachAckLimitLogEntry_id` | `string` | | -| `ReachAckLimitLogEntry_incident` | `object` | | -| `ReachAckLimitLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ReachAckLimitLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ReachAckLimitLogEntry_service` | `object` | | -| `ReachAckLimitLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ReachAckLimitLogEntry_teams` | `array` | Will consist of references unless included | -| `ReachAckLimitLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ReachTriggerLimitLogEntry__type` | `string` | | -| `ReachTriggerLimitLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ReachTriggerLimitLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ReachTriggerLimitLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ReachTriggerLimitLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ReachTriggerLimitLogEntry_event_details` | `object` | | -| `ReachTriggerLimitLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ReachTriggerLimitLogEntry_id` | `string` | | -| `ReachTriggerLimitLogEntry_incident` | `object` | | -| `ReachTriggerLimitLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ReachTriggerLimitLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ReachTriggerLimitLogEntry_service` | `object` | | -| `ReachTriggerLimitLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ReachTriggerLimitLogEntry_teams` | `array` | Will consist of references unless included | -| `ReachTriggerLimitLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `RepeatEscalationPathLogEntry__type` | `string` | | -| `RepeatEscalationPathLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `RepeatEscalationPathLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `RepeatEscalationPathLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `RepeatEscalationPathLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `RepeatEscalationPathLogEntry_event_details` | `object` | | -| `RepeatEscalationPathLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `RepeatEscalationPathLogEntry_id` | `string` | | -| `RepeatEscalationPathLogEntry_incident` | `object` | | -| `RepeatEscalationPathLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `RepeatEscalationPathLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `RepeatEscalationPathLogEntry_service` | `object` | | -| `RepeatEscalationPathLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `RepeatEscalationPathLogEntry_teams` | `array` | Will consist of references unless included | -| `RepeatEscalationPathLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `ResolveLogEntry__type` | `string` | | -| `ResolveLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `ResolveLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `ResolveLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `ResolveLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `ResolveLogEntry_event_details` | `object` | | -| `ResolveLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `ResolveLogEntry_id` | `string` | | -| `ResolveLogEntry_incident` | `object` | | -| `ResolveLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `ResolveLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `ResolveLogEntry_service` | `object` | | -| `ResolveLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `ResolveLogEntry_teams` | `array` | Will consist of references unless included | -| `ResolveLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `SnoozeLogEntry__type` | `string` | | -| `SnoozeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `SnoozeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `SnoozeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `SnoozeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `SnoozeLogEntry_event_details` | `object` | | -| `SnoozeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `SnoozeLogEntry_id` | `string` | | -| `SnoozeLogEntry_incident` | `object` | | -| `SnoozeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `SnoozeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `SnoozeLogEntry_service` | `object` | | -| `SnoozeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `SnoozeLogEntry_teams` | `array` | Will consist of references unless included | -| `SnoozeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `TriggerLogEntry__type` | `string` | | -| `TriggerLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `TriggerLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `TriggerLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `TriggerLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `TriggerLogEntry_event_details` | `object` | | -| `TriggerLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `TriggerLogEntry_id` | `string` | | -| `TriggerLogEntry_incident` | `object` | | -| `TriggerLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `TriggerLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `TriggerLogEntry_service` | `object` | | -| `TriggerLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `TriggerLogEntry_teams` | `array` | Will consist of references unless included | -| `TriggerLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `UnacknowledgeLogEntry__type` | `string` | | -| `UnacknowledgeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `UnacknowledgeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `UnacknowledgeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `UnacknowledgeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `UnacknowledgeLogEntry_event_details` | `object` | | -| `UnacknowledgeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `UnacknowledgeLogEntry_id` | `string` | | -| `UnacknowledgeLogEntry_incident` | `object` | | -| `UnacknowledgeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `UnacknowledgeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `UnacknowledgeLogEntry_service` | `object` | | -| `UnacknowledgeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `UnacknowledgeLogEntry_teams` | `array` | Will consist of references unless included | -| `UnacknowledgeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `UrgencyChangeLogEntry__type` | `string` | | -| `UrgencyChangeLogEntry_agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `UrgencyChangeLogEntry_channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `UrgencyChangeLogEntry_contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `UrgencyChangeLogEntry_created_at` | `string` | Time at which the log entry was created. | -| `UrgencyChangeLogEntry_event_details` | `object` | | -| `UrgencyChangeLogEntry_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `UrgencyChangeLogEntry_id` | `string` | | -| `UrgencyChangeLogEntry_incident` | `object` | | -| `UrgencyChangeLogEntry_note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `UrgencyChangeLogEntry_self` | `string` | the API show URL at which the object is accessible | -| `UrgencyChangeLogEntry_service` | `object` | | -| `UrgencyChangeLogEntry_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `UrgencyChangeLogEntry_teams` | `array` | Will consist of references unless included | -| `UrgencyChangeLogEntry_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `_created_at` | `string` | Time at which the log entry was created | -| `_type` | `string` | | -| `acknowledgement_timeout` | `integer` | Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set. | -| `agent` | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | -| `assignees` | `array` | An array of assigned Users for this log entry | -| `changed_actions` | `array` | | -| `channel` | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | -| `contexts` | `array` | Contexts to be included with the trigger such as links to graphs or images. | -| `created_at` | `string` | Time at which the log entry was created. | -| `event_details` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `incident` | `object` | | -| `note` | `string` | Optional field containing a note, if one was included with the log entry. | -| `self` | `string` | the API show URL at which the object is accessible | -| `service` | `object` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | Will consist of references unless included | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `user` | `object` | | +| | `string` | | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | Time at which the log entry was created | +| | `string` | | +| | `integer` | Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set. | +| | `object` | The agent (user, service or integration) that created or modified the Incident Log Entry. | +| | `array` | An array of assigned Users for this log entry | +| | `array` | | +| | `object` | Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. | +| | `array` | Contexts to be included with the trigger such as links to graphs or images. | +| | `string` | Time at which the log entry was created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `string` | Optional field containing a note, if one was included with the log entry. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | Will consist of references unless included | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_log_entry` | `SELECT` | `id` | Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| -| `list_log_entries` | `SELECT` | | List all of the incident log entries across the entire account.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| -| `_get_log_entry` | `EXEC` | `id` | Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| -| `_list_log_entries` | `EXEC` | | List all of the incident log entries across the entire account.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| -| `update_log_entry_channel` | `EXEC` | `From, id, data__channel` | Update an existing incident log entry channel.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.write`
| +| | `SELECT` | | Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| +| | `SELECT` | | List all of the incident log entries across the entire account.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | List all of the incident log entries across the entire account.

A log of all the events that happen to an Incident, and these are exposed as Log Entries.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.read`
| +| | `EXEC` | | Update an existing incident log entry channel.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#log-entries)

Scoped OAuth requires: `incidents.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/index.md b/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/index.md index 7a62d33a1f..b3ce116cb1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Maintenance Windows :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/maintenance_windows/index.md b/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/maintenance_windows/index.md index feaffa1577..5306aa667c 100644 --- a/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/maintenance_windows/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/maintenance_windows/maintenance_windows/index.md @@ -14,39 +14,42 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemaintenance_windows
TypeResource
Idpagerduty.maintenance_windows.maintenance_windows
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `description` | `string` | A description for this maintenance window. | -| `_type` | `string` | The type of object being created. | -| `created_by` | `object` | | -| `end_time` | `string` | This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `sequence_number` | `integer` | The order in which the maintenance window was created. | -| `services` | `array` | | -| `start_time` | `string` | This maintenance window's start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | A description for this maintenance window. | +| | `string` | The type of object being created. | +| | `object` | | +| | `string` | This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the `start_time`. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `integer` | The order in which the maintenance window was created. | +| | `array` | | +| | `string` | This maintenance window's start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_maintenance_window` | `SELECT` | `id` | Get an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| -| `list_maintenance_windows` | `SELECT` | | List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| -| `create_maintenance_window` | `INSERT` | `From, data__maintenance_window` | Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| -| `delete_maintenance_window` | `DELETE` | `id` | Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| -| `_get_maintenance_window` | `EXEC` | `id` | Get an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| -| `_list_maintenance_windows` | `EXEC` | | List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| -| `update_maintenance_window` | `EXEC` | `id, data__maintenance_window` | Update an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| +| | `SELECT` | | List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| +| | `DELETE` | | Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update an existing maintenance window.

A Maintenance Window is used to temporarily disable one or more Services for a set period of time.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#maintenance-windows)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/notifications/index.md b/docs/pagerduty-docs/providers/pagerduty/notifications/index.md index 9e2b184672..51f293f999 100644 --- a/docs/pagerduty-docs/providers/pagerduty/notifications/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/notifications/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Notification Is Created When An Incident Is Triggered Or Escalated. diff --git a/docs/pagerduty-docs/providers/pagerduty/notifications/notifications/index.md b/docs/pagerduty-docs/providers/pagerduty/notifications/notifications/index.md index f2433ace83..7ae16639ad 100644 --- a/docs/pagerduty-docs/providers/pagerduty/notifications/notifications/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/notifications/notifications/index.md @@ -14,29 +14,32 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotifications
TypeResource
Idpagerduty.notifications.notifications
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `` | `string` | | -| `address` | `string` | The address where the notification was sent. This will be null for notification type `push_notification`. | -| `conferenceAddress` | `string` | The address of the conference bridge | -| `started_at` | `string` | The time at which the notification was sent | -| `status` | `string` | | -| `type` | `string` | The type of notification. | -| `user` | `object` | | +| | `string` | | +| | `string` | | +| | `string` | The address where the notification was sent. This will be null for notification type `push_notification`. | +| | `string` | The address of the conference bridge | +| | `string` | The time at which the notification was sent | +| | `string` | | +| | `string` | The type of notification. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_notifications` | `SELECT` | `since, until` | -| `_list_notifications` | `EXEC` | `since, until` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/on_calls/index.md b/docs/pagerduty-docs/providers/pagerduty/on_calls/index.md index 8bcfe91b1d..48f35fc3e1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/on_calls/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/on_calls/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + An On-Call Represents A Contiguous Unit Of Time For Which A User Will Be On Call For A Given Escalation Policy And Escalation Rules diff --git a/docs/pagerduty-docs/providers/pagerduty/on_calls/oncalls/index.md b/docs/pagerduty-docs/providers/pagerduty/on_calls/oncalls/index.md index 8fbb1d2327..93120898c8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/on_calls/oncalls/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/on_calls/oncalls/index.md @@ -14,27 +14,30 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoncalls
TypeResource
Idpagerduty.on_calls.oncalls
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `end` | `string` | The end of the on-call. If `null`, the user does not go off-call. | -| `escalation_level` | `integer` | The escalation level for the on-call. | -| `escalation_policy` | `object` | | -| `schedule` | `object` | | -| `start` | `string` | The start of the on-call. If `null`, the on-call is a permanent user on-call. | -| `user` | `object` | | +| | `string` | The end of the on-call. If `null`, the user does not go off-call. | +| | `integer` | The escalation level for the on-call. | +| | `object` | | +| | `object` | | +| | `string` | The start of the on-call. If `null`, the on-call is a permanent user on-call. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_on_calls` | `SELECT` | | -| `_list_on_calls` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/alerts/index.md b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/alerts/index.md index 068c215c6a..8140a6e0f8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/alerts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/alerts/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namealerts
TypeResource
Idpagerduty.paused_incident_reports.alerts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resolved_after_pause_alerts` | `array` | An array of Alerts that were resolved after being paused. | -| `since` | `string` | The start of the date range over which the report data is represented. | -| `triggered_after_pause_alerts` | `array` | An array of Alerts that were triggered after being paused. | -| `until` | `string` | The end of the date range over which the report data is represented. | +| | `array` | An array of Alerts that were resolved after being paused. | +| | `string` | The start of the date range over which the report data is represented. | +| | `array` | An array of Alerts that were triggered after being paused. | +| | `string` | The end of the date range over which the report data is represented. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_paused_incident_report_alerts` | `SELECT` | | -| `_get_paused_incident_report_alerts` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/counts/index.md b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/counts/index.md index b35db1ae2b..5c2f1e25b7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/counts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/counts/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecounts
TypeResource
Idpagerduty.paused_incident_reports.counts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `paused_count` | `number` | The total number of paused Alerts for the Account or Servce. | -| `resolved_after_pause_count` | `number` | The total number of paused Alerts for the Account or Service that were resolved after being paused and not triggered (transient Alerts). | -| `since` | `string` | The start of the date range over which the report data is represented. | -| `triggered_after_pause_count` | `number` | The total number of paused Alerts for the Account or Service that were triggerd after being paused (non-transient Alerts). | -| `until` | `string` | The end of the date range over which the report data is represented. | +| | `number` | The total number of paused Alerts for the Account or Servce. | +| | `number` | The total number of paused Alerts for the Account or Service that were resolved after being paused and not triggered (transient Alerts). | +| | `string` | The start of the date range over which the report data is represented. | +| | `number` | The total number of paused Alerts for the Account or Service that were triggerd after being paused (non-transient Alerts). | +| | `string` | The end of the date range over which the report data is represented. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_paused_incident_report_counts` | `SELECT` | | -| `_get_paused_incident_report_counts` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/index.md b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/index.md index 2e9a95fb3b..edd3e505d9 100644 --- a/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/paused_incident_reports/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Paused Incident Reports :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/priorities/index.md b/docs/pagerduty-docs/providers/pagerduty/priorities/index.md index e6cbfa5bc9..ddd779b731 100644 --- a/docs/pagerduty-docs/providers/pagerduty/priorities/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/priorities/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Priority Is A Label Representing The Importance And Impact Of An Incident. This Feature Is Only Available On Standard And Enterprise Plans. diff --git a/docs/pagerduty-docs/providers/pagerduty/priorities/priorities/index.md b/docs/pagerduty-docs/providers/pagerduty/priorities/priorities/index.md index 866fec7214..073bd84ecc 100644 --- a/docs/pagerduty-docs/providers/pagerduty/priorities/priorities/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/priorities/priorities/index.md @@ -14,28 +14,31 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepriorities
TypeResource
Idpagerduty.priorities.priorities
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The user-provided short name of the priority. | -| `description` | `string` | The user-provided description of the priority. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The user-provided short name of the priority. | +| | `string` | The user-provided description of the priority. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_priorities` | `SELECT` | | -| `_list_priorities` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/response_plays/index.md b/docs/pagerduty-docs/providers/pagerduty/response_plays/index.md index d39a0e666e..48b32090d7 100644 --- a/docs/pagerduty-docs/providers/pagerduty/response_plays/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/response_plays/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Response Plays :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/response_plays/response_plays/index.md b/docs/pagerduty-docs/providers/pagerduty/response_plays/response_plays/index.md index 3f71d06304..365c29fd99 100644 --- a/docs/pagerduty-docs/providers/pagerduty/response_plays/response_plays/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/response_plays/response_plays/index.md @@ -14,44 +14,47 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameresponse_plays
TypeResource
Idpagerduty.response_plays.response_plays
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the response play. | -| `description` | `string` | The description of the response play. | -| `_type` | `string` | The type of object being created. | -| `conference_number` | `string` | The telephone number that will be set as the conference number for any incident on which this response play is run. | -| `conference_type` | `string` | This field has three possible values and indicates how the response play was created.
- `none` : The response play had no conference_number or conference_url set at time of creation.
- `manual` : The response play had one or both of conference_number and conference_url set at time of creation.
- `zoom` : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom | -| `conference_url` | `string` | The URL that will be set as the conference URL for any incident on which this response play is run. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `responders` | `array` | An array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run. | -| `responders_message` | `string` | The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent. | -| `runnability` | `string` | String representing how this response play is allowed to be run. Valid options are:
- `services`: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play.
- `teams`: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the `team` property for this response play is not empty.
- `responders`: This response play can be run manually on an incident by any responders in this account. | -| `self` | `string` | the API show URL at which the object is accessible | -| `subscribers` | `array` | An array containing the users and/or teams to be added as subscribers to any incident on which this response play is run. | -| `subscribers_message` | `string` | The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `team` | `` | | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the response play. | +| | `string` | The description of the response play. | +| | `string` | The type of object being created. | +| | `string` | The telephone number that will be set as the conference number for any incident on which this response play is run. | +| | `string` | This field has three possible values and indicates how the response play was created.
- `none` : The response play had no conference_number or conference_url set at time of creation.
- `manual` : The response play had one or both of conference_number and conference_url set at time of creation.
- `zoom` : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom | +| | `string` | The URL that will be set as the conference URL for any incident on which this response play is run. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `array` | An array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run. | +| | `string` | The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent. | +| | `string` | String representing how this response play is allowed to be run. Valid options are:
- `services`: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play.
- `teams`: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the `team` property for this response play is not empty.
- `responders`: This response play can be run manually on an incident by any responders in this account. | +| | `string` | the API show URL at which the object is accessible | +| | `array` | An array containing the users and/or teams to be added as subscribers to any incident on which this response play is run. | +| | `string` | The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `` | | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_response_play` | `SELECT` | `id` | Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
| -| `list_response_plays` | `SELECT` | | List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
| -| `create_response_play` | `INSERT` | `From, data__response_play` | Creates a new Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| -| `delete_response_play` | `DELETE` | `From, id` | Delete an existing Response Play. Once the Response Play is deleted, the action cannot be undone.

WARNING: When the Response Play is deleted, it is also removed from any Services that were using it.

Response Plays allow you to create packages of Incident Actions that can be applied to an Incident.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| -| `_get_response_play` | `EXEC` | `id` | Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
| -| `_list_response_plays` | `EXEC` | | List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
| -| `run_response_play` | `EXEC` | `From, response_play_id, data__incident` | Run a specified response play on a given incident.

Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| -| `update_response_play` | `EXEC` | `From, id, data__response_play` | Updates an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| +| | `SELECT` | | Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
| +| | `SELECT` | | List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
| +| | `INSERT` | | Creates a new Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| +| | `DELETE` | | Delete an existing Response Play. Once the Response Play is deleted, the action cannot be undone.

WARNING: When the Response Play is deleted, it is also removed from any Services that were using it.

Response Plays allow you to create packages of Incident Actions that can be applied to an Incident.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| +| | `EXEC` | | Get details about an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.
Scoped OAuth requires: `response_plays.read`
| +| | `EXEC` | | List all of the existing Response Plays.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

When using a Global API token, the `From` header is required.

Scoped OAuth requires: `response_plays.read`
| +| | `EXEC` | | Run a specified response play on a given incident.

Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| +| | `EXEC` | | Updates an existing Response Play.

Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#response-plays)

Scoped OAuth requires: `response_plays.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/rulesets/index.md b/docs/pagerduty-docs/providers/pagerduty/rulesets/index.md index d3fdfb4bdf..21119432e1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/rulesets/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/rulesets/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Rulesets Allow You To Route Events To An Endpoint And Create Collections Of Event Rules, Which Define Sets Of Actions To Take Based On Event Content. diff --git a/docs/pagerduty-docs/providers/pagerduty/rulesets/rules/index.md b/docs/pagerduty-docs/providers/pagerduty/rulesets/rules/index.md index ac9116735e..0956b8110c 100644 --- a/docs/pagerduty-docs/providers/pagerduty/rulesets/rules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/rulesets/rules/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idpagerduty.rulesets.rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the Event Rule. | -| `actions` | `object` | When an event matches this rule, the actions that will be taken to change the resulting alert and incident. | -| `catch_all` | `boolean` | Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches. | -| `conditions` | `object` | Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though. | -| `disabled` | `boolean` | Indicates whether the Event Rule is disabled and would therefore not be evaluated. | -| `position` | `integer` | Position/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found. | -| `self` | `string` | the API show URL at which the object is accessible. | -| `time_frame` | `object` | Time-based conditions for limiting when the rule is active. | -| `variables` | `array` | [Early Access] Populate variables from event payloads and use those variables in other event actions. | +| | `string` | ID of the Event Rule. | +| | `object` | When an event matches this rule, the actions that will be taken to change the resulting alert and incident. | +| | `boolean` | Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches. | +| | `object` | Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though. | +| | `boolean` | Indicates whether the Event Rule is disabled and would therefore not be evaluated. | +| | `integer` | Position/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found. | +| | `string` | the API show URL at which the object is accessible. | +| | `object` | Time-based conditions for limiting when the rule is active. | +| | `array` | [Early Access] Populate variables from event payloads and use those variables in other event actions. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_ruleset_event_rule` | `SELECT` | `id, rule_id` | Get an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| -| `list_ruleset_event_rules` | `SELECT` | `id` | List all Event Rules on a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| -| `create_ruleset_event_rule` | `INSERT` | `id, data__rule` | Create a new Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.write`
| -| `delete_ruleset_event_rule` | `DELETE` | `id, rule_id` | Delete an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| -| `_get_ruleset_event_rule` | `EXEC` | `id, rule_id` | Get an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| -| `_list_ruleset_event_rules` | `EXEC` | `id` | List all Event Rules on a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| -| `update_ruleset_event_rule` | `EXEC` | `id, rule_id, data__rule_id` | Update an Event Rule. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.write`
| +| | `SELECT` | | Get an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| +| | `SELECT` | | List all Event Rules on a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| +| | `INSERT` | | Create a new Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.write`
| +| | `DELETE` | | Delete an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| +| | `EXEC` | | Get an Event Rule.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| +| | `EXEC` | | List all Event Rules on a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.read`
| +| | `EXEC` | | Update an Event Rule. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead.

Scoped OAuth requires: `event_rules.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/rulesets/rulesets/index.md b/docs/pagerduty-docs/providers/pagerduty/rulesets/rulesets/index.md index 8de8290e7f..1cc30c9764 100644 --- a/docs/pagerduty-docs/providers/pagerduty/rulesets/rulesets/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/rulesets/rulesets/index.md @@ -14,36 +14,39 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerulesets
TypeResource
Idpagerduty.rulesets.rulesets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the Ruleset. | -| `name` | `string` | Name of the Ruleset. | -| `created_at` | `string` | The date the Ruleset was created at. | -| `creator` | `object` | Reference to the user that has created the Ruleset. | -| `routing_keys` | `array` | Routing keys routed to this Ruleset. | -| `self` | `string` | the API show URL at which the object is accessible | -| `team` | `object` | Reference to the team that owns the Ruleset. If none is specified, only admins have access. | -| `type` | `string` | | -| `updated_at` | `string` | The date the Ruleset was last updated. | -| `updater` | `object` | Reference to the user that has updated the Ruleset last. | +| | `string` | ID of the Ruleset. | +| | `string` | Name of the Ruleset. | +| | `string` | The date the Ruleset was created at. | +| | `object` | Reference to the user that has created the Ruleset. | +| | `array` | Routing keys routed to this Ruleset. | +| | `string` | the API show URL at which the object is accessible | +| | `object` | Reference to the team that owns the Ruleset. If none is specified, only admins have access. | +| | `string` | | +| | `string` | The date the Ruleset was last updated. | +| | `object` | Reference to the user that has updated the Ruleset last. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_ruleset` | `SELECT` | `id` | Get a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| -| `list_rulesets` | `SELECT` | | List all Rulesets
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| -| `create_ruleset` | `INSERT` | `data__ruleset` | Create a new Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| -| `delete_ruleset` | `DELETE` | `id` | Delete a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| -| `_get_ruleset` | `EXEC` | `id` | Get a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| -| `_list_rulesets` | `EXEC` | | List all Rulesets
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| -| `update_ruleset` | `EXEC` | `id, data__ruleset` | Update a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| +| | `SELECT` | | Get a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| +| | `SELECT` | | List all Rulesets
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| +| | `INSERT` | | Create a new Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| +| | `DELETE` | | Delete a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| +| | `EXEC` | | Get a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| +| | `EXEC` | | List all Rulesets
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.read`
| +| | `EXEC` | | Update a Ruleset.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#rulesets)

Scoped OAuth requires: `event_rules.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/schedules/audit_records/index.md b/docs/pagerduty-docs/providers/pagerduty/schedules/audit_records/index.md index 8a1d155f11..c55a0d1fc5 100644 --- a/docs/pagerduty-docs/providers/pagerduty/schedules/audit_records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/schedules/audit_records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_records
TypeResource
Idpagerduty.schedules.audit_records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_schedules_audit_records` | `SELECT` | `id` | -| `_list_schedules_audit_records` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/schedules/index.md b/docs/pagerduty-docs/providers/pagerduty/schedules/index.md index fe76e73e4b..97b456a48b 100644 --- a/docs/pagerduty-docs/providers/pagerduty/schedules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/schedules/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Schedule Determines The Time Periods That Users Are On-Call. diff --git a/docs/pagerduty-docs/providers/pagerduty/schedules/overrides/index.md b/docs/pagerduty-docs/providers/pagerduty/schedules/overrides/index.md index 5b0c9265f5..1da276d247 100644 --- a/docs/pagerduty-docs/providers/pagerduty/schedules/overrides/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/schedules/overrides/index.md @@ -14,32 +14,35 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoverrides
TypeResource
Idpagerduty.schedules.overrides
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_id` | `string` | | -| `end` | `string` | The end date and time for the override. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `start` | `string` | The start date and time for the override. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `user` | `object` | | +| | `string` | | +| | `string` | | +| | `string` | The end date and time for the override. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | The start date and time for the override. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_schedule_overrides` | `SELECT` | `id, since, until` | List overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| -| `create_schedule_override` | `INSERT` | `id` | Create one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority.

A Schedule determines the time periods that users are On-Call.

Note: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| -| `delete_schedule_override` | `DELETE` | `id, override_id` | Remove an override.

You cannot remove a past override.

If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time.

If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| -| `_list_schedule_overrides` | `EXEC` | `id, since, until` | List overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| +| | `SELECT` | | List overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| +| | `INSERT` | | Create one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority.

A Schedule determines the time periods that users are On-Call.

Note: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `DELETE` | | Remove an override.

You cannot remove a past override.

If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time.

If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `EXEC` | | List overrides for a given time range.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/schedules/schedules/index.md b/docs/pagerduty-docs/providers/pagerduty/schedules/schedules/index.md index f6a5d182ec..579590d558 100644 --- a/docs/pagerduty-docs/providers/pagerduty/schedules/schedules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/schedules/schedules/index.md @@ -14,42 +14,45 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameschedules
TypeResource
Idpagerduty.schedules.schedules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the schedule | -| `description` | `string` | The description of the schedule | -| `_type` | `string` | The type of object being created. | -| `escalation_policies` | `array` | An array of all of the escalation policies that uses this schedule. | -| `final_schedule` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `overrides_subschedule` | `object` | | -| `schedule_layers` | `array` | A list of schedule layers. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | An array of all of the teams on the schedule. | -| `time_zone` | `string` | The time zone of the schedule. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `users` | `array` | An array of all of the users on the schedule. | +| | `string` | | +| | `string` | The name of the schedule | +| | `string` | The description of the schedule | +| | `string` | The type of object being created. | +| | `array` | An array of all of the escalation policies that uses this schedule. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `array` | A list of schedule layers. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | An array of all of the teams on the schedule. | +| | `string` | The time zone of the schedule. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `array` | An array of all of the users on the schedule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_schedule` | `SELECT` | `id` | Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
| -| `list_schedules` | `SELECT` | | List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| -| `create_schedule` | `INSERT` | `data__schedule` | Create a new on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| -| `create_schedule_preview` | `INSERT` | `data__schedule` | Preview what an on-call schedule would look like without saving it.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| -| `delete_schedule` | `DELETE` | `id` | Delete an on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| -| `_get_schedule` | `EXEC` | `id` | Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
| -| `_list_schedules` | `EXEC` | | List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| -| `update_schedule` | `EXEC` | `id, data__schedule` | Update an existing on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `SELECT` | | Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
| +| | `SELECT` | | List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| +| | `INSERT` | | Create a new on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `INSERT` | | Preview what an on-call schedule would look like without saving it.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `DELETE` | | Delete an on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| +| | `EXEC` | | Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
| +| | `EXEC` | | List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.read`
| +| | `EXEC` | | Update an existing on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)

Scoped OAuth requires: `schedules.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/schedules/users/index.md b/docs/pagerduty-docs/providers/pagerduty/schedules/users/index.md index 468df545f6..5b3e57beeb 100644 --- a/docs/pagerduty-docs/providers/pagerduty/schedules/users/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/schedules/users/index.md @@ -14,40 +14,43 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idpagerduty.schedules.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the user. | -| `description` | `string` | The user's bio. | -| `_type` | `string` | The type of object being created. | -| `avatar_url` | `string` | The URL of the user's avatar. | -| `color` | `string` | The schedule color. | -| `contact_methods` | `array` | The list of contact methods for the user. | -| `email` | `string` | The user's email address. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `invitation_sent` | `boolean` | If true, the user has an outstanding invitation. | -| `job_title` | `string` | The user's title. | -| `license` | `object` | The License assigned to the User | -| `notification_rules` | `array` | The list of notification rules for the user. | -| `role` | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | -| `time_zone` | `string` | The preferred time zone name. If null, the account's time zone will be used. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the user. | +| | `string` | The user's bio. | +| | `string` | The type of object being created. | +| | `string` | The URL of the user's avatar. | +| | `string` | The schedule color. | +| | `array` | The list of contact methods for the user. | +| | `string` | The user's email address. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `boolean` | If true, the user has an outstanding invitation. | +| | `string` | The user's title. | +| | `object` | The License assigned to the User | +| | `array` | The list of notification rules for the user. | +| | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | +| | `string` | The preferred time zone name. If null, the account's time zone will be used. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_schedule_users` | `SELECT` | `id` | -| `_list_schedule_users` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/business_services/index.md b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/business_services/index.md index 2b9eef9a18..e23d9c20b9 100644 --- a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/business_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/business_services/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebusiness_services
TypeResource
Idpagerduty.service_dependencies.business_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `dependent_service` | `object` | The reference to the service that is dependent on the Business Service. | -| `supporting_service` | `object` | The reference to the service that supports the Business Service. | -| `type` | `string` | | +| | `string` | | +| | `object` | The reference to the service that is dependent on the Business Service. | +| | `object` | The reference to the service that supports the Business Service. | +| | `string` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_business_service_service_dependencies` | `SELECT` | `id` | -| `_get_business_service_service_dependencies` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/index.md b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/index.md index 7fbbd778fb..3a212ec59f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Service Dependencies :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/technical_services/index.md b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/technical_services/index.md index d8eb20b4a4..568a804c71 100644 --- a/docs/pagerduty-docs/providers/pagerduty/service_dependencies/technical_services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/service_dependencies/technical_services/index.md @@ -14,27 +14,30 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametechnical_services
TypeResource
Idpagerduty.service_dependencies.technical_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `dependent_service` | `object` | The reference to the service that is dependent on the technical service. | -| `supporting_service` | `object` | The reference to the service that supports the technical service. | -| `type` | `string` | | +| | `string` | | +| | `object` | The reference to the service that is dependent on the technical service. | +| | `object` | The reference to the service that supports the technical service. | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_technical_service_service_dependencies` | `SELECT` | `id` | Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `create_service_dependency` | `INSERT` | | Create new dependencies between two services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

A service can have a maximum of 2,000 dependencies with a depth limit of 100. If the limit is reached, the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| -| `_get_technical_service_service_dependencies` | `EXEC` | `id` | Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `delete_service_dependency` | `EXEC` | | Disassociate dependencies between two services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create new dependencies between two services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

A service can have a maximum of 2,000 dependencies with a depth limit of 100. If the limit is reached, the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get all immediate dependencies of any technical service.
Technical services are also known as `services`.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Disassociate dependencies between two services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#business-services)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/services/audit_records/index.md b/docs/pagerduty-docs/providers/pagerduty/services/audit_records/index.md index 1f620af1d3..0a63cfe2bf 100644 --- a/docs/pagerduty-docs/providers/pagerduty/services/audit_records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/services/audit_records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_records
TypeResource
Idpagerduty.services.audit_records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_service_audit_records` | `SELECT` | `id` | -| `_list_service_audit_records` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/services/index.md b/docs/pagerduty-docs/providers/pagerduty/services/index.md index 3d4c5e7cdf..c00855aca8 100644 --- a/docs/pagerduty-docs/providers/pagerduty/services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/services/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Service May Represent An Application, Component, Or Team You Wish To Open Incidents Against. diff --git a/docs/pagerduty-docs/providers/pagerduty/services/integrations/index.md b/docs/pagerduty-docs/providers/pagerduty/services/integrations/index.md index 86a497f83a..9d61415323 100644 --- a/docs/pagerduty-docs/providers/pagerduty/services/integrations/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/services/integrations/index.md @@ -14,39 +14,42 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameintegrations
TypeResource
Idpagerduty.services.integrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of this integration. | -| `_type` | `string` | | -| `created_at` | `string` | The date/time when this integration was created. | -| `email_filter_mode` | `string` | Specify for generic_email_inbound_integration. May override email_incident_creation | -| `email_filters` | `array` | Specify for generic_email_inbound_integration. | -| `email_incident_creation` | `string` | Specify for generic_email_inbound_integration | -| `email_parsers` | `array` | Specify for generic_email_inbound_integration. | -| `email_parsing_fallback` | `string` | Specify for generic_email_inbound_integration. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `integration_email` | `string` | Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com | -| `self` | `string` | the API show URL at which the object is accessible | -| `service` | `object` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `vendor` | `object` | | +| | `string` | | +| | `string` | The name of this integration. | +| | `string` | | +| | `string` | The date/time when this integration was created. | +| | `string` | Specify for generic_email_inbound_integration. May override email_incident_creation | +| | `array` | Specify for generic_email_inbound_integration. | +| | `string` | Specify for generic_email_inbound_integration | +| | `array` | Specify for generic_email_inbound_integration. | +| | `string` | Specify for generic_email_inbound_integration. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com | +| | `string` | the API show URL at which the object is accessible | +| | `object` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_service_integration` | `SELECT` | `id, integration_id` | Get details about an integration belonging to a service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `create_service_integration` | `INSERT` | `id, data__integration` | Create a new integration belonging to a Service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| -| `_get_service_integration` | `EXEC` | `id, integration_id` | Get details about an integration belonging to a service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `update_service_integration` | `EXEC` | `id, integration_id, data__integration` | Update an integration belonging to a Service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get details about an integration belonging to a service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create a new integration belonging to a Service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get details about an integration belonging to a service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update an integration belonging to a Service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/services/rules/index.md b/docs/pagerduty-docs/providers/pagerduty/services/rules/index.md index 0fff9a1f4d..b857a858d1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/services/rules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/services/rules/index.md @@ -14,34 +14,37 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerules
TypeResource
Idpagerduty.services.rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the Event Rule. | -| `actions` | `object` | When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident. | -| `conditions` | `object` | Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though. | -| `disabled` | `boolean` | Indicates whether the Event Rule is disabled and would therefore not be evaluated. | -| `position` | `integer` | Position/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached. | -| `self` | `string` | the API show URL at which the object is accessible. | -| `time_frame` | `object` | Time-based conditions for limiting when the rule is active. | -| `variables` | `array` | [Early Access] Populate variables from event payloads and use those variables in other event actions. | +| | `string` | ID of the Event Rule. | +| | `object` | When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident. | +| | `object` | Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though. | +| | `boolean` | Indicates whether the Event Rule is disabled and would therefore not be evaluated. | +| | `integer` | Position/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached. | +| | `string` | the API show URL at which the object is accessible. | +| | `object` | Time-based conditions for limiting when the rule is active. | +| | `array` | [Early Access] Populate variables from event payloads and use those variables in other event actions. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_service_event_rule` | `SELECT` | `id, rule_id` | Get an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| -| `list_service_event_rules` | `SELECT` | `id` | List Event Rules on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| -| `create_service_event_rule` | `INSERT` | `id, data__rule` | Create a new Event Rule on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| -| `delete_service_event_rule` | `DELETE` | `id, rule_id` | Delete an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| -| `_get_service_event_rule` | `EXEC` | `id, rule_id` | Get an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| -| `_list_service_event_rules` | `EXEC` | `id` | List Event Rules on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| -| `update_service_event_rule` | `EXEC` | `id, rule_id, data__rule_id` | Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| +| | `SELECT` | | List Event Rules on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create a new Event Rule on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| +| | `DELETE` | | Delete an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get an Event Rule from a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | List Event Rules on a Service.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.
<!-- theme: warning -->
> ### End-of-life
> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/services/services/index.md b/docs/pagerduty-docs/providers/pagerduty/services/services/index.md index 5ad662f0fe..333f1971ac 100644 --- a/docs/pagerduty-docs/providers/pagerduty/services/services/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/services/services/index.md @@ -14,52 +14,55 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservices
TypeResource
Idpagerduty.services.services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the service. | -| `description` | `string` | The user-provided description of the service. | -| `_type` | `string` | The type of object being created. | -| `acknowledgement_timeout` | `integer` | Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. | -| `addons` | `array` | The array of Add-ons associated with this service. | -| `alert_creation` | `string` | Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging.
* "create_incidents" - The service will create one incident and zero alerts for each incoming event.
* "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.
| -| `alert_grouping` | `string` | Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options:
* null - No alert grouping on the service. Each alert will create a separate incident;
* "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans;
* "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans
| -| `alert_grouping_parameters` | `object` | Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.
| -| `alert_grouping_timeout` | `integer` | The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.
| -| `auto_pause_notifications_parameters` | `object` | Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans. | -| `auto_resolve_timeout` | `integer` | Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. | -| `created_at` | `string` | The date/time when this service was created | -| `escalation_policy` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `incident_urgency_rule` | `object` | | -| `integrations` | `array` | An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references. | -| `last_incident_timestamp` | `string` | The date/time when the most recent incident was created for this service. | -| `response_play` | `object` | Response plays associated with this service. | -| `scheduled_actions` | `array` | An array containing scheduled actions for the service. | -| `self` | `string` | the API show URL at which the object is accessible | -| `status` | `string` | The current state of the Service. Valid statuses are:


- `active`: The service is enabled and has no open incidents. This is the only status a service can be created with.
- `warning`: The service is enabled and has one or more acknowledged incidents.
- `critical`: The service is enabled and has one or more triggered incidents.
- `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode.
- `disabled`: The service is disabled and will not have any new triggered incidents.
| -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `support_hours` | `object` | | -| `teams` | `array` | The set of teams associated with this service. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the service. | +| | `string` | The user-provided description of the service. | +| | `string` | The type of object being created. | +| | `integer` | Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. | +| | `array` | The array of Add-ons associated with this service. | +| | `string` | Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging.
* "create_incidents" - The service will create one incident and zero alerts for each incoming event.
* "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.
| +| | `string` | Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options:
* null - No alert grouping on the service. Each alert will create a separate incident;
* "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans;
* "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans
| +| | `object` | Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.
| +| | `integer` | The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`.
| +| | `object` | Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans. | +| | `integer` | Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. | +| | `string` | The date/time when this service was created | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `array` | An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references. | +| | `string` | The date/time when the most recent incident was created for this service. | +| | `object` | Response plays associated with this service. | +| | `array` | An array containing scheduled actions for the service. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | The current state of the Service. Valid statuses are:


- `active`: The service is enabled and has no open incidents. This is the only status a service can be created with.
- `warning`: The service is enabled and has one or more acknowledged incidents.
- `critical`: The service is enabled and has one or more triggered incidents.
- `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode.
- `disabled`: The service is disabled and will not have any new triggered incidents.
| +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `object` | | +| | `array` | The set of teams associated with this service. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_service` | `SELECT` | `id` | Get details about an existing service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `list_services` | `SELECT` | | List existing Services.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `create_service` | `INSERT` | `data__service` | Create a new service.

If `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service.

A service may represent an application, component, or team you wish to open incidents against.

There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and `auto_resolve_timeout` is disabled (set to 0 or null), the `auto_resolve_timeout` property will automatically be set to 84600 (1 day).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| -| `delete_service` | `DELETE` | `id` | Delete an existing service.

Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| -| `_get_service` | `EXEC` | `id` | Get details about an existing service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `_list_services` | `EXEC` | | List existing Services.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| -| `update_service` | `EXEC` | `id, data__service` | Update an existing service.

A service may represent an application, component, or team you wish to open incidents against.

There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| +| | `SELECT` | | Get details about an existing service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `SELECT` | | List existing Services.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `INSERT` | | Create a new service.

If `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service.

A service may represent an application, component, or team you wish to open incidents against.

There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and `auto_resolve_timeout` is disabled (set to 0 or null), the `auto_resolve_timeout` property will automatically be set to 84600 (1 day).

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| +| | `DELETE` | | Delete an existing service.

Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| +| | `EXEC` | | Get details about an existing service.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | List existing Services.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.read`
| +| | `EXEC` | | Update an existing service.

A service may represent an application, component, or team you wish to open incidents against.

There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)

Scoped OAuth requires: `services.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/index.md b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/index.md index c06673eed9..4c44b2bf7d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Status Dashboards :::info Service Summary diff --git a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/service_impacts/index.md b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/service_impacts/index.md index 7ff1254d3f..ee23d2833d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/service_impacts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/service_impacts/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_impacts
TypeResource
Idpagerduty.status_dashboards.service_impacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `additional_fields` | `object` | | -| `status` | `string` | The current impact status of the object | -| `type` | `string` | The kind of object that has been impacted | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | The current impact status of the object | +| | `string` | The kind of object that has been impacted | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_status_dashboard_service_impacts_by_id` | `SELECT` | `X-EARLY-ACCESS, id` | -| `_get_status_dashboard_service_impacts_by_id` | `EXEC` | `X-EARLY-ACCESS, id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/status_dashboards/index.md b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/status_dashboards/index.md index cca9b5f216..f2f09f185d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/status_dashboards/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/status_dashboards/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus_dashboards
TypeResource
Idpagerduty.status_dashboards.status_dashboards
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `url_slug` | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_status_dashboard_by_id` | `SELECT` | `X-EARLY-ACCESS, id` | Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `list_status_dashboards` | `SELECT` | `X-EARLY-ACCESS` | Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `_get_status_dashboard_by_id` | `EXEC` | `X-EARLY-ACCESS, id` | Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | -| `_list_status_dashboards` | `EXEC` | `X-EARLY-ACCESS` | Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `SELECT` | | Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `SELECT` | | Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Get a Status Dashboard by its PagerDuty `id`.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | +| | `EXEC` | | Get all your account's custom Status Dashboard views

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. | diff --git a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs/index.md b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs/index.md index 570d8a30ab..f5b71a64a6 100644 --- a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameurl_slugs
TypeResource
Idpagerduty.status_dashboards.url_slugs
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `url_slug` | `string` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_status_dashboard_by_url_slug` | `SELECT` | `X-EARLY-ACCESS, url_slug` | -| `_get_status_dashboard_by_url_slug` | `EXEC` | `X-EARLY-ACCESS, url_slug` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs_service_impacts/index.md b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs_service_impacts/index.md index 1f7d6dc5d9..0a1f9b1bfb 100644 --- a/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs_service_impacts/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/status_dashboards/url_slugs_service_impacts/index.md @@ -14,26 +14,29 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameurl_slugs_service_impacts
TypeResource
Idpagerduty.status_dashboards.url_slugs_service_impacts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | | -| `additional_fields` | `object` | | -| `status` | `string` | The current impact status of the object | -| `type` | `string` | The kind of object that has been impacted | +| | `string` | | +| | `string` | | +| | `object` | | +| | `string` | The current impact status of the object | +| | `string` | The kind of object that has been impacted | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_status_dashboard_service_impacts_by_url_slug` | `SELECT` | `X-EARLY-ACCESS, url_slug` | -| `_get_status_dashboard_service_impacts_by_url_slug` | `EXEC` | `X-EARLY-ACCESS, url_slug` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/tags/index.md b/docs/pagerduty-docs/providers/pagerduty/tags/index.md index af18600847..72a7d02ca1 100644 --- a/docs/pagerduty-docs/providers/pagerduty/tags/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/tags/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Tag Is Applied To Escalation Policies, Teams Or Users And Can Be Used To Filter Them. diff --git a/docs/pagerduty-docs/providers/pagerduty/tags/tags/index.md b/docs/pagerduty-docs/providers/pagerduty/tags/tags/index.md index 0674787079..a87916de0d 100644 --- a/docs/pagerduty-docs/providers/pagerduty/tags/tags/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/tags/tags/index.md @@ -14,37 +14,40 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags
TypeResource
Idpagerduty.tags.tags
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | The type of object being created. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `label` | `string` | The label of the tag. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The type of object being created. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | The label of the tag. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_entity_type_by_id_tags` | `SELECT` | `entity_type, id` | Get related tags for Users, Teams or Escalation Policies.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `get_tag` | `SELECT` | `id` | Get details about an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `get_tags_by_entity_type` | `SELECT` | `entity_type, id` | Get related Users, Teams or Escalation Policies for the Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `list_tags` | `SELECT` | | List all of your account's tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `create_entity_type_by_id_change_tags` | `INSERT` | `entity_type, id` | Assign existing or new tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| -| `create_tags` | `INSERT` | `data__tag` | Create a Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| -| `delete_tag` | `DELETE` | `id` | Remove an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| -| `_get_entity_type_by_id_tags` | `EXEC` | `entity_type, id` | Get related tags for Users, Teams or Escalation Policies.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `_get_tag` | `EXEC` | `id` | Get details about an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `_get_tags_by_entity_type` | `EXEC` | `entity_type, id` | Get related Users, Teams or Escalation Policies for the Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| -| `_list_tags` | `EXEC` | | List all of your account's tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `SELECT` | | Get related tags for Users, Teams or Escalation Policies.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `SELECT` | | Get details about an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `SELECT` | | Get related Users, Teams or Escalation Policies for the Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `SELECT` | | List all of your account's tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `INSERT` | | Assign existing or new tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| +| | `INSERT` | | Create a Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| +| | `DELETE` | | Remove an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.write`
| +| | `EXEC` | | Get related tags for Users, Teams or Escalation Policies.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `EXEC` | | Get details about an existing Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `EXEC` | | Get related Users, Teams or Escalation Policies for the Tag.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| +| | `EXEC` | | List all of your account's tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#tags)

Scoped OAuth requires: `tags.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/audit_records/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/audit_records/index.md index 5a46353a52..ed74d1e96e 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/audit_records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/audit_records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_records
TypeResource
Idpagerduty.teams.audit_records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_teams_audit_records` | `SELECT` | `id` | -| `_list_teams_audit_records` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/escalation_policies/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/escalation_policies/index.md index 7fb2c3e308..80489c566e 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/escalation_policies/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/escalation_policies/index.md @@ -14,14 +14,17 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameescalation_policies
TypeResource
Idpagerduty.teams.escalation_policies
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `delete_team_escalation_policy` | `DELETE` | `escalation_policy_id, id` | Remove an escalation policy from a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| -| `update_team_escalation_policy` | `EXEC` | `escalation_policy_id, id` | Add an escalation policy to a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `DELETE` | | Remove an escalation policy from a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `EXEC` | | Add an escalation policy to a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/index.md index 23a73e1458..e2b59a7cfd 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Team Is A Collection Of Users And Escalation Policies That Represent A Group Of People Within An Organization. diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/members/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/members/index.md index faebaa850f..6853194dc4 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/members/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/members/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemembers
TypeResource
Idpagerduty.teams.members
Id
## Fields | Name | Datatype | |:-----|:---------| -| `role` | `string` | -| `user` | `object` | +| | `string` | +| | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_team_users` | `SELECT` | `id` | Get information about members on a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `delete_team_user` | `DELETE` | `id, user_id` | Remove a user from a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| -| `_list_team_users` | `EXEC` | `id` | Get information about members on a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `update_team_user` | `EXEC` | `id, user_id` | Add a user to a team. Attempting to add a user with the `read_only_user` role will return a 400 error.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `SELECT` | | Get information about members on a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `DELETE` | | Remove a user from a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `EXEC` | | Get information about members on a team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `EXEC` | | Add a user to a team. Attempting to add a user with the `read_only_user` role will return a 400 error.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/notification_subscriptions/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/notification_subscriptions/index.md index 1079837ce9..6a1d084bfd 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/notification_subscriptions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/notification_subscriptions/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotification_subscriptions
TypeResource
Idpagerduty.teams.notification_subscriptions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `subscribable_name` | `string` | The name of the subscribable | -| `subscription` | `object` | An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. | +| | `string` | The name of the subscribable | +| | `object` | An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_notification_subscriptions` | `SELECT` | `id` | Retrieve a list of Notification Subscriptions the given Team has.

<!-- theme: warning -->
> Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| -| `create_team_notification_subscriptions` | `INSERT` | `id, data__subscribables` | Create new Notification Subscriptions for the given Team.

Scoped OAuth requires: `subscribers.write`
| -| `_get_team_notification_subscriptions` | `EXEC` | `id` | Retrieve a list of Notification Subscriptions the given Team has.

<!-- theme: warning -->
> Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| -| `remove_team_notification_subscriptions` | `EXEC` | `id, data__subscribables` | Unsubscribe the given Team from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
| +| | `SELECT` | | Retrieve a list of Notification Subscriptions the given Team has.

<!-- theme: warning -->
> Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| +| | `INSERT` | | Create new Notification Subscriptions for the given Team.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Retrieve a list of Notification Subscriptions the given Team has.

<!-- theme: warning -->
> Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| +| | `EXEC` | | Unsubscribe the given Team from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/teams/teams/index.md b/docs/pagerduty-docs/providers/pagerduty/teams/teams/index.md index 30f26ed336..46960c89bf 100644 --- a/docs/pagerduty-docs/providers/pagerduty/teams/teams/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/teams/teams/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteams
TypeResource
Idpagerduty.teams.teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the team. | -| `description` | `string` | The description of the team. | -| `_type` | `string` | The type of object being created. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `parent` | `object` | | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the team. | +| | `string` | The description of the team. | +| | `string` | The type of object being created. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `object` | | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team` | `SELECT` | `id` | Get details about an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `list_teams` | `SELECT` | | List teams of your PagerDuty account, optionally filtered by a search query.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `create_team` | `INSERT` | `data__team` | Create a new Team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| -| `delete_team` | `DELETE` | `id` | Remove an existing team.

Succeeds only if the team has no associated Escalation Policies, Services, Schedules and Subteams.

All associated unresovled incidents will be reassigned to another team (if specified) or will loose team association, thus becoming account-level (with visibility implications).

Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the API call return.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| -| `_get_team` | `EXEC` | `id` | Get details about an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `_list_teams` | `EXEC` | | List teams of your PagerDuty account, optionally filtered by a search query.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| -| `update_team` | `EXEC` | `id, data__team` | Update an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `SELECT` | | Get details about an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `SELECT` | | List teams of your PagerDuty account, optionally filtered by a search query.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `INSERT` | | Create a new Team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `DELETE` | | Remove an existing team.

Succeeds only if the team has no associated Escalation Policies, Services, Schedules and Subteams.

All associated unresovled incidents will be reassigned to another team (if specified) or will loose team association, thus becoming account-level (with visibility implications).

Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the API call return.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| +| | `EXEC` | | Get details about an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `EXEC` | | List teams of your PagerDuty account, optionally filtered by a search query.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.read`
| +| | `EXEC` | | Update an existing team.

A team is a collection of Users and Escalation Policies that represent a group of people within an organization.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)

Scoped OAuth requires: `teams.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/templates/index.md b/docs/pagerduty-docs/providers/pagerduty/templates/index.md index 5e9cf3f713..c8f890f433 100644 --- a/docs/pagerduty-docs/providers/pagerduty/templates/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/templates/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Templates Is A New Feature Which Will Allow Customers To Create Message Templates To Be Leveraged By (But Not Limited To) Status Updates. The API Will Be Secured To Customers With The Status Updates Entitlements. diff --git a/docs/pagerduty-docs/providers/pagerduty/templates/templates/index.md b/docs/pagerduty-docs/providers/pagerduty/templates/templates/index.md index 2a40e40d43..9d0be5b2ae 100644 --- a/docs/pagerduty-docs/providers/pagerduty/templates/templates/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/templates/templates/index.md @@ -14,38 +14,41 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametemplates
TypeResource
Idpagerduty.templates.templates
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the template | -| `description` | `string` | Description of the template | -| `created_by` | `` | User/Account object reference of the creator | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `template_type` | `string` | The type of template (`status_update` is the only supported template at this time) | -| `templated_fields` | `object` | | -| `type` | `string` | | -| `updated_by` | `` | User/Account object reference of the updator | +| | `string` | | +| | `string` | The name of the template | +| | `string` | Description of the template | +| | `` | User/Account object reference of the creator | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | The type of template (`status_update` is the only supported template at this time) | +| | `object` | | +| | `string` | | +| | `` | User/Account object reference of the updator | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_template` | `SELECT` | `id` | Get a single template on the account

Scoped OAuth requires: `templates.read`
| -| `get_templates` | `SELECT` | | Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
| -| `create_template` | `INSERT` | `data__template` | Create a new template

Scoped OAuth requires: `templates.write`
| -| `delete_template` | `DELETE` | `id` | Delete a specific of templates on the account

Scoped OAuth requires: `templates.write`
| -| `_get_template` | `EXEC` | `id` | Get a single template on the account

Scoped OAuth requires: `templates.read`
| -| `_get_templates` | `EXEC` | | Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
| -| `render_template` | `EXEC` | `id` | Render a template. This endpoint has a variable request body depending on the template type. For the `status_update` template type, the caller will provide the incident id, and a status update message.

Scoped OAuth requires: `templates.read`
| -| `update_template` | `EXEC` | `id, data__template` | Update an existing template

Scoped OAuth requires: `templates.write`
| +| | `SELECT` | | Get a single template on the account

Scoped OAuth requires: `templates.read`
| +| | `SELECT` | | Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
| +| | `INSERT` | | Create a new template

Scoped OAuth requires: `templates.write`
| +| | `DELETE` | | Delete a specific of templates on the account

Scoped OAuth requires: `templates.write`
| +| | `EXEC` | | Get a single template on the account

Scoped OAuth requires: `templates.read`
| +| | `EXEC` | | Get a list of all the template on an account

Scoped OAuth requires: `templates.read`
| +| | `EXEC` | | Render a template. This endpoint has a variable request body depending on the template type. For the `status_update` template type, the caller will provide the incident id, and a status update message.

Scoped OAuth requires: `templates.read`
| +| | `EXEC` | | Update an existing template

Scoped OAuth requires: `templates.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/audit_records/index.md b/docs/pagerduty-docs/providers/pagerduty/users/audit_records/index.md index 9ba1357fa3..9c32b1e483 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/audit_records/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/audit_records/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_records
TypeResource
Idpagerduty.users.audit_records
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `action` | `string` | | -| `actors` | `array` | | -| `details` | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| -| `execution_context` | `object` | Action execution context | -| `execution_time` | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | -| `method` | `object` | The method information | -| `root_resource` | `object` | | -| `self` | `string` | Record URL. | +| | `string` | | +| | `string` | | +| | `array` | | +| | `object` | Additional details to provide further information about the action or
the resource that has been audited.
| +| | `object` | Action execution context | +| | `string` | The date/time the action executed, in ISO8601 format and millisecond precision. | +| | `object` | The method information | +| | `object` | | +| | `string` | Record URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_users_audit_records` | `SELECT` | `id` | -| `_list_users_audit_records` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/users/contact_methods/index.md b/docs/pagerduty-docs/providers/pagerduty/users/contact_methods/index.md index 1470960533..d782a3a37e 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/contact_methods/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/contact_methods/index.md @@ -14,58 +14,61 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontact_methods
TypeResource
Idpagerduty.users.contact_methods
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `EmailContactMethod__type` | `string` | | -| `EmailContactMethod_address` | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | -| `EmailContactMethod_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `EmailContactMethod_id` | `string` | | -| `EmailContactMethod_label` | `string` | The label (e.g., "Work", "Mobile", etc.). | -| `EmailContactMethod_self` | `string` | the API show URL at which the object is accessible | -| `EmailContactMethod_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `EmailContactMethod_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `PushContactMethod__type` | `string` | | -| `PushContactMethod_address` | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | -| `PushContactMethod_blacklisted` | `boolean` | If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it. | -| `PushContactMethod_html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `PushContactMethod_id` | `string` | | -| `PushContactMethod_label` | `string` | The label (e.g., "Work", "Mobile", etc.). | -| `PushContactMethod_self` | `string` | the API show URL at which the object is accessible | -| `PushContactMethod_summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `PushContactMethod_type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `_type` | `string` | | -| `address` | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | -| `blacklisted` | `boolean` | If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it. | -| `country_code` | `integer` | The 1-to-3 digit country calling code. | -| `created_at` | `string` | Time at which the contact method was created. | -| `device_type` | `string` | The type of device. | -| `enabled` | `boolean` | If true, this phone is capable of receiving SMS messages. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `label` | `string` | The label (e.g., "Work", "Mobile", etc.). | -| `self` | `string` | the API show URL at which the object is accessible | -| `send_short_email` | `boolean` | Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers. | -| `sounds` | `array` | | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | | +| | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `string` | The label (e.g., "Work", "Mobile", etc.). | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | +| | `boolean` | If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | | +| | `string` | The label (e.g., "Work", "Mobile", etc.). | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The "address" to deliver to: email, phone number, etc., depending on the type. | +| | `boolean` | If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it. | +| | `integer` | The 1-to-3 digit country calling code. | +| | `string` | Time at which the contact method was created. | +| | `string` | The type of device. | +| | `boolean` | If true, this phone is capable of receiving SMS messages. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | The label (e.g., "Work", "Mobile", etc.). | +| | `string` | the API show URL at which the object is accessible | +| | `boolean` | Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers. | +| | `array` | | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_contact_method` | `SELECT` | `contact_method_id, id` | Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `get_user_contact_methods` | `SELECT` | `id` | List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `create_user_contact_method` | `INSERT` | `id, data__contact_method` | Create a new contact method for the User.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| -| `delete_user_contact_method` | `DELETE` | `contact_method_id, id` | Remove a user's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| -| `_get_user_contact_method` | `EXEC` | `contact_method_id, id` | Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `_get_user_contact_methods` | `EXEC` | `id` | List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `update_user_contact_method` | `EXEC` | `contact_method_id, id, data__contact_method` | Update a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `SELECT` | | Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `SELECT` | | List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `INSERT` | | Create a new contact method for the User.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `DELETE` | | Remove a user's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `EXEC` | | Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `EXEC` | | List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `EXEC` | | Update a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/index.md b/docs/pagerduty-docs/providers/pagerduty/users/index.md index 28136a4bb0..e8ea4ab55e 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + Users Are Members Of A PagerDuty Account That Have The Ability To Interact With Incidents And Other Data On The Account. diff --git a/docs/pagerduty-docs/providers/pagerduty/users/license/index.md b/docs/pagerduty-docs/providers/pagerduty/users/license/index.md index c04424f609..dbbb334f1f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/license/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/license/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelicense
TypeResource
Idpagerduty.users.license
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Uniquely identifies the resource | -| `name` | `string` | Name of the License.
| -| `description` | `string` | Description of the License. May include the names of add-ons associated with
the License, if there are any.
| -| `html_url` | `string` | HTML URL to access the License | -| `role_group` | `string` | Indicates whether this License is assignable to full or stakeholder Users | -| `self` | `string` | API URL to access the License | -| `summary` | `string` | Summary of the License | -| `type` | `string` | Type of object | -| `valid_roles` | `array` | The roles a User with this License can have | +| | `string` | Uniquely identifies the resource | +| | `string` | Name of the License.
| +| | `string` | Description of the License. May include the names of add-ons associated with
the License, if there are any.
| +| | `string` | HTML URL to access the License | +| | `string` | Indicates whether this License is assignable to full or stakeholder Users | +| | `string` | API URL to access the License | +| | `string` | Summary of the License | +| | `string` | Type of object | +| | `array` | The roles a User with this License can have | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_user_license` | `SELECT` | `id` | -| `_get_user_license` | `EXEC` | `id` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/users/me/index.md b/docs/pagerduty-docs/providers/pagerduty/users/me/index.md index 51bae902a0..26123b3138 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/me/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/me/index.md @@ -14,40 +14,43 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameme
TypeResource
Idpagerduty.users.me
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the user. | -| `description` | `string` | The user's bio. | -| `_type` | `string` | The type of object being created. | -| `avatar_url` | `string` | The URL of the user's avatar. | -| `color` | `string` | The schedule color. | -| `contact_methods` | `array` | The list of contact methods for the user. | -| `email` | `string` | The user's email address. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `invitation_sent` | `boolean` | If true, the user has an outstanding invitation. | -| `job_title` | `string` | The user's title. | -| `license` | `object` | The License assigned to the User | -| `notification_rules` | `array` | The list of notification rules for the user. | -| `role` | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | -| `time_zone` | `string` | The preferred time zone name. If null, the account's time zone will be used. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the user. | +| | `string` | The user's bio. | +| | `string` | The type of object being created. | +| | `string` | The URL of the user's avatar. | +| | `string` | The schedule color. | +| | `array` | The list of contact methods for the user. | +| | `string` | The user's email address. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `boolean` | If true, the user has an outstanding invitation. | +| | `string` | The user's title. | +| | `object` | The License assigned to the User | +| | `array` | The list of notification rules for the user. | +| | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | +| | `string` | The preferred time zone name. If null, the account's time zone will be used. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_current_user` | `SELECT` | | -| `_get_current_user` | `EXEC` | | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/pagerduty-docs/providers/pagerduty/users/notification_rules/index.md b/docs/pagerduty-docs/providers/pagerduty/users/notification_rules/index.md index 83d6fcea54..22130fd9dd 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/notification_rules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/notification_rules/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotification_rules
TypeResource
Idpagerduty.users.notification_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `_type` | `string` | The type of object being created. | -| `contact_method` | `object` | | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `self` | `string` | the API show URL at which the object is accessible | -| `start_delay_in_minutes` | `integer` | The delay before firing the rule, in minutes. | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `urgency` | `string` | Which incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule. | +| | `string` | | +| | `string` | The type of object being created. | +| | `object` | | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | the API show URL at which the object is accessible | +| | `integer` | The delay before firing the rule, in minutes. | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | Which incident urgency this rule is used for. Account must have the `urgencies` ability to have a low urgency notification rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_notification_rule` | `SELECT` | `id, notification_rule_id` | Get details about a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `get_user_notification_rules` | `SELECT` | `id` | List notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `create_user_notification_rule` | `INSERT` | `id, data__notification_rule` | Create a new notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| -| `delete_user_notification_rule` | `DELETE` | `id, notification_rule_id` | Remove a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| -| `_get_user_notification_rule` | `EXEC` | `id, notification_rule_id` | Get details about a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `_get_user_notification_rules` | `EXEC` | `id` | List notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| -| `update_user_notification_rule` | `EXEC` | `id, notification_rule_id, data__notification_rule` | Update a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `SELECT` | | Get details about a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `SELECT` | | List notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `INSERT` | | Create a new notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `DELETE` | | Remove a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| +| | `EXEC` | | Get details about a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `EXEC` | | List notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.read`
| +| | `EXEC` | | Update a user's notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:contact_methods.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/notification_subscriptions/index.md b/docs/pagerduty-docs/providers/pagerduty/users/notification_subscriptions/index.md index 6a3097f85a..41e554a77f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/notification_subscriptions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/notification_subscriptions/index.md @@ -14,25 +14,28 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namenotification_subscriptions
TypeResource
Idpagerduty.users.notification_subscriptions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `subscribable_name` | `string` | The name of the subscribable | -| `subscription` | `object` | An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. | +| | `string` | The name of the subscribable | +| | `object` | An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_notification_subscriptions` | `SELECT` | `id` | Retrieve a list of Notification Subscriptions the given User has.

<!-- theme: warning -->
> Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| -| `create_user_notification_subscriptions` | `INSERT` | `id, data__subscribables` | Create new Notification Subscriptions for the given User.

Scoped OAuth requires: `subscribers.write`
| -| `_get_user_notification_subscriptions` | `EXEC` | `id` | Retrieve a list of Notification Subscriptions the given User has.

<!-- theme: warning -->
> Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| -| `unsubscribe_user_notification_subscriptions` | `EXEC` | `id, data__subscribables` | Unsubscribe the given User from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
| +| | `SELECT` | | Retrieve a list of Notification Subscriptions the given User has.

<!-- theme: warning -->
> Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| +| | `INSERT` | | Create new Notification Subscriptions for the given User.

Scoped OAuth requires: `subscribers.write`
| +| | `EXEC` | | Retrieve a list of Notification Subscriptions the given User has.

<!-- theme: warning -->
> Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint.

Scoped OAuth requires: `subscribers.read`
| +| | `EXEC` | | Unsubscribe the given User from Notifications on the matching Subscribable entities.

Scoped OAuth requires: `subscribers.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/oncall_handoff_notification_rules/index.md b/docs/pagerduty-docs/providers/pagerduty/users/oncall_handoff_notification_rules/index.md index 948e6c7d92..e7245e7a43 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/oncall_handoff_notification_rules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/oncall_handoff_notification_rules/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameoncall_handoff_notification_rules
TypeResource
Idpagerduty.users.oncall_handoff_notification_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `contact_method` | `object` | | -| `handoff_type` | `string` | The type of handoff being created. | -| `notify_advance_in_minutes` | `integer` | The delay before firing the rule, in minutes. | +| | `string` | | +| | `object` | | +| | `string` | The type of handoff being created. | +| | `integer` | The delay before firing the rule, in minutes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_handoff_notifiaction_rule` | `SELECT` | `id, oncall_handoff_notification_rule_id` | Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `get_user_handoff_notification_rules` | `SELECT` | `id` | List Handoff Notification Rules of your PagerDuty User.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `create_user_handoff_notification_rule` | `INSERT` | `id, data__oncall_handoff_notification_rule` | Create a new Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `delete_user_handoff_notification_rule` | `DELETE` | `id, oncall_handoff_notification_rule_id` | Remove a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `_get_user_handoff_notifiaction_rule` | `EXEC` | `id, oncall_handoff_notification_rule_id` | Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `_get_user_handoff_notification_rules` | `EXEC` | `id` | List Handoff Notification Rules of your PagerDuty User.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `update_user_handoff_notification` | `EXEC` | `id, oncall_handoff_notification_rule_id, data__oncall_handoff_notification_rule` | Update a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `SELECT` | | Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `SELECT` | | List Handoff Notification Rules of your PagerDuty User.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `INSERT` | | Create a new Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `DELETE` | | Remove a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `EXEC` | | Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | List Handoff Notification Rules of your PagerDuty User.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | Update a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/sessions/index.md b/docs/pagerduty-docs/providers/pagerduty/users/sessions/index.md index 0b02110ca0..16ddb19f1c 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/sessions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/sessions/index.md @@ -14,30 +14,33 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesessions
TypeResource
Idpagerduty.users.sessions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `created_at` | `string` | The date/time the user session was first created. | -| `summary` | `string` | The summary of the session | -| `type` | `string` | The type of the session | -| `user_id` | `string` | | +| | `string` | | +| | `string` | The date/time the user session was first created. | +| | `string` | The summary of the session | +| | `string` | The type of the session | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_session` | `SELECT` | `id, session_id, type` | Get details about a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| -| `get_user_sessions` | `SELECT` | `id` | List active sessions of a PagerDuty user.

Beginning November 2021, active sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| -| `delete_user_session` | `DELETE` | `id, session_id, type` | Delete a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
| -| `delete_user_sessions` | `DELETE` | `id` | Delete all user sessions.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
| -| `_get_user_session` | `EXEC` | `id, session_id, type` | Get details about a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| -| `_get_user_sessions` | `EXEC` | `id` | List active sessions of a PagerDuty user.

Beginning November 2021, active sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| +| | `SELECT` | | Get details about a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| +| | `SELECT` | | List active sessions of a PagerDuty user.

Beginning November 2021, active sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| +| | `DELETE` | | Delete a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
| +| | `DELETE` | | Delete all user sessions.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.write`
| +| | `EXEC` | | Get details about a user's session.

Beginning November 2021, user sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| +| | `EXEC` | | List active sessions of a PagerDuty user.

Beginning November 2021, active sessions no longer includes newly issued OAuth tokens.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users:sessions.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/status_update_notification_rules/index.md b/docs/pagerduty-docs/providers/pagerduty/users/status_update_notification_rules/index.md index 5d6aa498ec..3fd51d5062 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/status_update_notification_rules/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/status_update_notification_rules/index.md @@ -14,24 +14,27 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus_update_notification_rules
TypeResource
Idpagerduty.users.status_update_notification_rules
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user_status_update_notification_rule` | `SELECT` | `X-EARLY-ACCESS, id, status_update_notification_rule_id` | Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `get_user_status_update_notification_rules` | `SELECT` | `X-EARLY-ACCESS, id` | List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `create_user_status_update_notification_rule` | `INSERT` | `X-EARLY-ACCESS, id, data__status_update_notification_rule` | Create a new status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `delete_user_status_update_notification_rule` | `DELETE` | `X-EARLY-ACCESS, id, status_update_notification_rule_id` | Remove a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `_get_user_status_update_notification_rule` | `EXEC` | `X-EARLY-ACCESS, id, status_update_notification_rule_id` | Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `_get_user_status_update_notification_rules` | `EXEC` | `X-EARLY-ACCESS, id` | List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `update_user_status_update_notification_rule` | `EXEC` | `X-EARLY-ACCESS, id, status_update_notification_rule_id, data__status_update_notification_rule` | Update a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `SELECT` | | Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `SELECT` | | List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `INSERT` | | Create a new status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `DELETE` | | Remove a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `EXEC` | | Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | Update a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/users/users/index.md b/docs/pagerduty-docs/providers/pagerduty/users/users/index.md index a340b6c156..32d4491ba4 100644 --- a/docs/pagerduty-docs/providers/pagerduty/users/users/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/users/users/index.md @@ -14,45 +14,48 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Idpagerduty.users.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The name of the user. | -| `description` | `string` | The user's bio. | -| `_type` | `string` | The type of object being created. | -| `avatar_url` | `string` | The URL of the user's avatar. | -| `color` | `string` | The schedule color. | -| `contact_methods` | `array` | The list of contact methods for the user. | -| `email` | `string` | The user's email address. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `invitation_sent` | `boolean` | If true, the user has an outstanding invitation. | -| `job_title` | `string` | The user's title. | -| `license` | `object` | The License assigned to the User | -| `notification_rules` | `array` | The list of notification rules for the user. | -| `role` | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `teams` | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | -| `time_zone` | `string` | The preferred time zone name. If null, the account's time zone will be used. | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | | +| | `string` | The name of the user. | +| | `string` | The user's bio. | +| | `string` | The type of object being created. | +| | `string` | The URL of the user's avatar. | +| | `string` | The schedule color. | +| | `array` | The list of contact methods for the user. | +| | `string` | The user's email address. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `boolean` | If true, the user has an outstanding invitation. | +| | `string` | The user's title. | +| | `object` | The License assigned to the User | +| | `array` | The list of notification rules for the user. | +| | `string` | The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `array` | The list of teams to which the user belongs. Account must have the `teams` ability to set this. | +| | `string` | The preferred time zone name. If null, the account's time zone will be used. | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user` | `SELECT` | `id` | Get details about an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `list_users` | `SELECT` | | List users of your PagerDuty account, optionally filtered by a search query.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `create_user` | `INSERT` | `From, data__user` | Create a new user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `delete_user` | `DELETE` | `id` | Remove an existing user.

Returns 400 if the user has assigned incidents unless your [pricing plan](https://www.pagerduty.com/pricing) has the `offboarding` feature and the account is [configured](https://support.pagerduty.com/docs/offboarding#section-additional-configurations) appropriately.

Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return.

[*Learn more about `offboarding` feature*](https://support.pagerduty.com/docs/offboarding).

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| -| `_get_user` | `EXEC` | `id` | Get details about an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `_list_users` | `EXEC` | | List users of your PagerDuty account, optionally filtered by a search query.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| -| `update_user` | `EXEC` | `id, data__user` | Update an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `SELECT` | | Get details about an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `SELECT` | | List users of your PagerDuty account, optionally filtered by a search query.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `INSERT` | | Create a new user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `DELETE` | | Remove an existing user.

Returns 400 if the user has assigned incidents unless your [pricing plan](https://www.pagerduty.com/pricing) has the `offboarding` feature and the account is [configured](https://support.pagerduty.com/docs/offboarding#section-additional-configurations) appropriately.

Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return.

[*Learn more about `offboarding` feature*](https://support.pagerduty.com/docs/offboarding).

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| +| | `EXEC` | | Get details about an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | List users of your PagerDuty account, optionally filtered by a search query.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.read`
| +| | `EXEC` | | Update an existing user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#users)

Scoped OAuth requires: `users.write`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/vendors/index.md b/docs/pagerduty-docs/providers/pagerduty/vendors/index.md index c1e7f30837..ff6e4f52b4 100644 --- a/docs/pagerduty-docs/providers/pagerduty/vendors/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/vendors/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A PagerDuty Vendor Represents A Specific Type Of Integration. AWS Cloudwatch, Splunk, Datadog Are All Examples Of Vendors diff --git a/docs/pagerduty-docs/providers/pagerduty/vendors/vendors/index.md b/docs/pagerduty-docs/providers/pagerduty/vendors/vendors/index.md index a5719dd5f8..4b5f55184f 100644 --- a/docs/pagerduty-docs/providers/pagerduty/vendors/vendors/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/vendors/vendors/index.md @@ -14,34 +14,37 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevendors
TypeResource
Idpagerduty.vendors.vendors
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `name` | `string` | The short name of the vendor | -| `description` | `string` | A short description of this vendor, and common use-cases of integrations for this vendor. | -| `html_url` | `string` | a URL at which the entity is uniquely displayed in the Web app | -| `integration_guide_url` | `string` | URL of an integration guide for this vendor | -| `logo_url` | `string` | URL of a logo identifying the vendor | -| `self` | `string` | the API show URL at which the object is accessible | -| `summary` | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | -| `thumbnail_url` | `string` | URL of a small thumbnail image identifying the vendor | -| `type` | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | -| `website_url` | `string` | URL of the vendor's main website | +| | `string` | | +| | `string` | The short name of the vendor | +| | `string` | A short description of this vendor, and common use-cases of integrations for this vendor. | +| | `string` | a URL at which the entity is uniquely displayed in the Web app | +| | `string` | URL of an integration guide for this vendor | +| | `string` | URL of a logo identifying the vendor | +| | `string` | the API show URL at which the object is accessible | +| | `string` | A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. | +| | `string` | URL of a small thumbnail image identifying the vendor | +| | `string` | A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. | +| | `string` | URL of the vendor's main website | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_vendor` | `SELECT` | `id` | Get details about one specific vendor.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| -| `list_vendors` | `SELECT` | | List all vendors.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| -| `_get_vendor` | `EXEC` | `id` | Get details about one specific vendor.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| -| `_list_vendors` | `EXEC` | | List all vendors.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| +| | `SELECT` | | Get details about one specific vendor.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| +| | `SELECT` | | List all vendors.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| +| | `EXEC` | | Get details about one specific vendor.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| +| | `EXEC` | | List all vendors.

A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors

For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#vendors)

Scoped OAuth requires: `vendors.read`
| diff --git a/docs/pagerduty-docs/providers/pagerduty/webhooks/index.md b/docs/pagerduty-docs/providers/pagerduty/webhooks/index.md index 0d8309e4cd..0c4e717b70 100644 --- a/docs/pagerduty-docs/providers/pagerduty/webhooks/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/webhooks/index.md @@ -13,6 +13,7 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- + A Webhook Is A Way To Receive Events That Occur On The PagerDuty Platform Via An HTTP POST Request. V3 Webhooks Are Set Up By Creating A Webhook Subscription. diff --git a/docs/pagerduty-docs/providers/pagerduty/webhooks/webhook_subscriptions/index.md b/docs/pagerduty-docs/providers/pagerduty/webhooks/webhook_subscriptions/index.md index 90b14932b3..50d8d53f93 100644 --- a/docs/pagerduty-docs/providers/pagerduty/webhooks/webhook_subscriptions/index.md +++ b/docs/pagerduty-docs/providers/pagerduty/webhooks/webhook_subscriptions/index.md @@ -14,35 +14,38 @@ description: Query, manage, and integrate PagerDuty resources using SQL custom_edit_url: null image: /img/providers/pagerduty/stackql-pagerduty-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namewebhook_subscriptions
TypeResource
Idpagerduty.webhooks.webhook_subscriptions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `description` | `string` | A short description of the webhook subscription. | -| `active` | `boolean` | Determines whether this subscription will produce webhook events. | -| `delivery_method` | `object` | | -| `events` | `array` | The set of outbound event types the webhook will receive. | -| `filter` | `object` | | -| `type` | `string` | The type indicating the schema of the object. | +| | `string` | | +| | `string` | A short description of the webhook subscription. | +| | `boolean` | Determines whether this subscription will produce webhook events. | +| | `object` | | +| | `array` | The set of outbound event types the webhook will receive. | +| | `object` | | +| | `string` | The type indicating the schema of the object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_webhook_subscription` | `SELECT` | `id` | Gets details about an existing webhook subscription.
| -| `list_webhook_subscriptions` | `SELECT` | | List existing webhook subscriptions.

The `filter_type` and `filter_id` query parameters may be used to only show subscriptions
for a particular _service_ or _team_.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| -| `create_webhook_subscription` | `INSERT` | `data__webhook_subscription` | Creates a new webhook subscription.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| -| `delete_webhook_subscription` | `DELETE` | `id` | Deletes a webhook subscription.
| -| `_get_webhook_subscription` | `EXEC` | `id` | Gets details about an existing webhook subscription.
| -| `_list_webhook_subscriptions` | `EXEC` | | List existing webhook subscriptions.

The `filter_type` and `filter_id` query parameters may be used to only show subscriptions
for a particular _service_ or _team_.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| -| `enable_webhook_subscription` | `EXEC` | `id` | Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.)

Webhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server.
| -| `test_webhook_subscription` | `EXEC` | `id` | Test a webhook subscription.

Fires a test event against the webhook subscription. If properly configured,
this will deliver the `pagey.ping` webhook event to the destination.
| -| `update_webhook_subscription` | `EXEC` | `id` | Updates an existing webhook subscription.

Only the fields being updated need to be included on the request. This operation does not
support updating the `delivery_method` of the webhook subscription.
| +| | `SELECT` | | Gets details about an existing webhook subscription.
| +| | `SELECT` | | List existing webhook subscriptions.

The `filter_type` and `filter_id` query parameters may be used to only show subscriptions
for a particular _service_ or _team_.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| +| | `INSERT` | | Creates a new webhook subscription.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| +| | `DELETE` | | Deletes a webhook subscription.
| +| | `EXEC` | | Gets details about an existing webhook subscription.
| +| | `EXEC` | | List existing webhook subscriptions.

The `filter_type` and `filter_id` query parameters may be used to only show subscriptions
for a particular _service_ or _team_.

For more information on webhook subscriptions and how they are used to configure v3 webhooks
see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/).
| +| | `EXEC` | | Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.)

Webhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server.
| +| | `EXEC` | | Test a webhook subscription.

Fires a test event against the webhook subscription. If properly configured,
this will deliver the `pagey.ping` webhook event to the destination.
| +| | `EXEC` | | Updates an existing webhook subscription.

Only the fields being updated need to be included on the request. This operation does not
support updating the `delivery_method` of the webhook subscription.
| diff --git a/docs/vercel-docs/index.md b/docs/vercel-docs/index.md index 06dda84fdd..5b1643821d 100644 --- a/docs/vercel-docs/index.md +++ b/docs/vercel-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png id: vercel-doc slug: /providers/vercel - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Cloud platform for serverless deployment and hosting of web applications. :::info Provider Summary (v23.12.00183) @@ -49,7 +51,7 @@ REGISTRY PULL vercel; The following system environment variables are used for authentication by default: -- `VERCEL_API_TOKEN` - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) +- - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/vercel-docs/providers/vercel/aliases/aliases/index.md b/docs/vercel-docs/providers/vercel/aliases/aliases/index.md index 396680e643..ffbf926e27 100644 --- a/docs/vercel-docs/providers/vercel/aliases/aliases/index.md +++ b/docs/vercel-docs/providers/vercel/aliases/aliases/index.md @@ -14,36 +14,39 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namealiases
TypeResource
Idvercel.aliases.aliases
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `alias` | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain | -| `created` | `string` | The date when the alias was created | -| `createdAt` | `number` | The date when the alias was created in milliseconds since the UNIX epoch | -| `creator` | `object` | Information of the user who created the alias | -| `deletedAt` | `number` | The date when the alias was deleted in milliseconds since the UNIX epoch | -| `deployment` | `object` | A map with the deployment ID, URL and metadata | -| `deploymentId` | `string` | The deployment ID | -| `projectId` | `string` | The unique identifier of the project | -| `protectionBypass` | `object` | The protection bypass for the alias | -| `redirect` | `string` | Target destination domain for redirect when the alias is a redirect | -| `redirectStatusCode` | `number` | Status code to be used on redirect | -| `uid` | `string` | The unique identifier of the alias | -| `updatedAt` | `number` | The date when the alias was updated in milliseconds since the UNIX epoch | +| | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain | +| | `string` | The date when the alias was created | +| | `number` | The date when the alias was created in milliseconds since the UNIX epoch | +| | `object` | Information of the user who created the alias | +| | `number` | The date when the alias was deleted in milliseconds since the UNIX epoch | +| | `object` | A map with the deployment ID, URL and metadata | +| | `string` | The deployment ID | +| | `string` | The unique identifier of the project | +| | `object` | The protection bypass for the alias | +| | `string` | Target destination domain for redirect when the alias is a redirect | +| | `number` | Status code to be used on redirect | +| | `string` | The unique identifier of the alias | +| | `number` | The date when the alias was updated in milliseconds since the UNIX epoch | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_alias` | `SELECT` | `idOrAlias, teamId` | Retrieves an Alias for the given host name or alias ID. | -| `list_aliases` | `SELECT` | `teamId` | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. | -| `delete_alias` | `DELETE` | `aliasId, teamId` | Delete an Alias with the specified ID. | -| `_list_aliases` | `EXEC` | `teamId` | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. | +| | `SELECT` | | Retrieves an Alias for the given host name or alias ID. | +| | `SELECT` | | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. | +| | `DELETE` | | Delete an Alias with the specified ID. | +| | `EXEC` | | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. | diff --git a/docs/vercel-docs/providers/vercel/aliases/deployments/index.md b/docs/vercel-docs/providers/vercel/aliases/deployments/index.md index 8facbdad42..c3b977e108 100644 --- a/docs/vercel-docs/providers/vercel/aliases/deployments/index.md +++ b/docs/vercel-docs/providers/vercel/aliases/deployments/index.md @@ -14,27 +14,30 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeployments
TypeResource
Idvercel.aliases.deployments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `alias` | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain | -| `created` | `string` | The date when the alias was created | -| `protectionBypass` | `object` | The protection bypass for the alias | -| `redirect` | `string` | Target destination domain for redirect when the alias is a redirect | -| `uid` | `string` | The unique identifier of the alias | +| | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain | +| | `string` | The date when the alias was created | +| | `object` | The protection bypass for the alias | +| | `string` | Target destination domain for redirect when the alias is a redirect | +| | `string` | The unique identifier of the alias | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_deployment_aliases` | `SELECT` | `id, teamId` | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. | -| `_list_deployment_aliases` | `EXEC` | `id, teamId` | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. | -| `assign_alias` | `EXEC` | `id, teamId` | Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one. | +| | `SELECT` | | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. | +| | `EXEC` | | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. | +| | `EXEC` | | Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one. | diff --git a/docs/vercel-docs/providers/vercel/aliases/index.md b/docs/vercel-docs/providers/vercel/aliases/index.md index 9be6807880..f77c14b394 100644 --- a/docs/vercel-docs/providers/vercel/aliases/index.md +++ b/docs/vercel-docs/providers/vercel/aliases/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Aliases :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/artifacts/artifacts/index.md b/docs/vercel-docs/providers/vercel/artifacts/artifacts/index.md index 12a4aff7a2..5fc533a80e 100644 --- a/docs/vercel-docs/providers/vercel/artifacts/artifacts/index.md +++ b/docs/vercel-docs/providers/vercel/artifacts/artifacts/index.md @@ -14,14 +14,17 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameartifacts
TypeResource
Idvercel.artifacts.artifacts
Id
## Fields @@ -29,9 +32,9 @@ image: /img/providers/vercel/stackql-vercel-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `artifact_exists` | `EXEC` | `hash, teamId` | Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body. | -| `artifact_query` | `EXEC` | `teamId, data__hashes` | Query information about an array of artifacts. | -| `download_artifact` | `EXEC` | `hash, teamId` | Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body. | -| `record_events` | `EXEC` | `teamId` | Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache. | -| `status` | `EXEC` | `teamId` | Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits. | -| `upload_artifact` | `EXEC` | `Content-Length, hash, teamId` | Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. | +| | `EXEC` | | Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body. | +| | `EXEC` | | Query information about an array of artifacts. | +| | `EXEC` | | Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body. | +| | `EXEC` | | Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache. | +| | `EXEC` | | Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits. | +| | `EXEC` | | Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. | diff --git a/docs/vercel-docs/providers/vercel/artifacts/index.md b/docs/vercel-docs/providers/vercel/artifacts/index.md index af50a8c4a3..fe6539279d 100644 --- a/docs/vercel-docs/providers/vercel/artifacts/index.md +++ b/docs/vercel-docs/providers/vercel/artifacts/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Artifacts :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/authentication/index.md b/docs/vercel-docs/providers/vercel/authentication/index.md index 9d0c414d92..dce93e080e 100644 --- a/docs/vercel-docs/providers/vercel/authentication/index.md +++ b/docs/vercel-docs/providers/vercel/authentication/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Authentication :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/authentication/user_tokens/index.md b/docs/vercel-docs/providers/vercel/authentication/user_tokens/index.md index 2de1f585e8..f7fa0f4abc 100644 --- a/docs/vercel-docs/providers/vercel/authentication/user_tokens/index.md +++ b/docs/vercel-docs/providers/vercel/authentication/user_tokens/index.md @@ -14,24 +14,27 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser_tokens
TypeResource
Idvercel.authentication.user_tokens
Id
## Fields ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_auth_token` | `SELECT` | `tokenId` | Retrieve metadata about an authentication token belonging to the currently authenticated User. | -| `list_auth_tokens` | `SELECT` | | Retrieve a list of the current User's authentication tokens. | -| `create_auth_token` | `INSERT` | `teamId` | Creates and returns a new authentication token for the currently authenticated User. The `bearerToken` property is only provided once, in the response body, so be sure to save it on the client for use with API requests. | -| `delete_auth_token` | `DELETE` | `tokenId` | Invalidate an authentication token, such that it will no longer be valid for future HTTP requests. | -| `_list_auth_tokens` | `EXEC` | | Retrieve a list of the current User's authentication tokens. | -| `email_login` | `EXEC` | `data__email` | Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token. | -| `verify_token` | `EXEC` | `token` | Verify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be added to the URL as a query string with the names `email` and `token`. | +| | `SELECT` | | Retrieve metadata about an authentication token belonging to the currently authenticated User. | +| | `SELECT` | | Retrieve a list of the current User's authentication tokens. | +| | `INSERT` | | Creates and returns a new authentication token for the currently authenticated User. The `bearerToken` property is only provided once, in the response body, so be sure to save it on the client for use with API requests. | +| | `DELETE` | | Invalidate an authentication token, such that it will no longer be valid for future HTTP requests. | +| | `EXEC` | | Retrieve a list of the current User's authentication tokens. | +| | `EXEC` | | Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token. | +| | `EXEC` | | Verify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be added to the URL as a query string with the names `email` and `token`. | diff --git a/docs/vercel-docs/providers/vercel/billing_settings/data_cache/index.md b/docs/vercel-docs/providers/vercel/billing_settings/data_cache/index.md index d5ae22763a..27a23f9334 100644 --- a/docs/vercel-docs/providers/vercel/billing_settings/data_cache/index.md +++ b/docs/vercel-docs/providers/vercel/billing_settings/data_cache/index.md @@ -14,14 +14,17 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedata_cache
TypeResource
Idvercel.billing_settings.data_cache
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/vercel/stackql-vercel-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `enable_excess_billing` | `EXEC` | | +| | `EXEC` | | diff --git a/docs/vercel-docs/providers/vercel/billing_settings/index.md b/docs/vercel-docs/providers/vercel/billing_settings/index.md index db2eca06ad..459e2b1bc6 100644 --- a/docs/vercel-docs/providers/vercel/billing_settings/index.md +++ b/docs/vercel-docs/providers/vercel/billing_settings/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Billing Settings :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/cache/data_cache_purge_all/index.md b/docs/vercel-docs/providers/vercel/cache/data_cache_purge_all/index.md index 15df0b609e..f6ce471eab 100644 --- a/docs/vercel-docs/providers/vercel/cache/data_cache_purge_all/index.md +++ b/docs/vercel-docs/providers/vercel/cache/data_cache_purge_all/index.md @@ -14,14 +14,17 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedata_cache_purge_all
TypeResource
Idvercel.cache.data_cache_purge_all
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/vercel/stackql-vercel-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `purge_all` | `EXEC` | `projectIdOrName` | +| | `EXEC` | | diff --git a/docs/vercel-docs/providers/vercel/cache/index.md b/docs/vercel-docs/providers/vercel/cache/index.md index 9fe1520b51..ed810b022d 100644 --- a/docs/vercel-docs/providers/vercel/cache/index.md +++ b/docs/vercel-docs/providers/vercel/cache/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Cache :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/certs/certs/index.md b/docs/vercel-docs/providers/vercel/certs/certs/index.md index 17b8bb8ca7..66018b375a 100644 --- a/docs/vercel-docs/providers/vercel/certs/certs/index.md +++ b/docs/vercel-docs/providers/vercel/certs/certs/index.md @@ -14,28 +14,31 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecerts
TypeResource
Idvercel.certs.certs
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `autoRenew` | `boolean` | -| `cns` | `array` | -| `createdAt` | `number` | -| `expiresAt` | `number` | +| | `string` | +| | `boolean` | +| | `array` | +| | `number` | +| | `number` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_cert_by_id` | `SELECT` | `id, teamId` | Get cert by id | -| `remove_cert` | `DELETE` | `id, teamId` | Remove cert | -| `issue_cert` | `EXEC` | `teamId` | Issue a new cert | -| `upload_cert` | `EXEC` | `teamId, data__ca, data__cert, data__key` | Upload a cert | +| | `SELECT` | | Get cert by id | +| | `DELETE` | | Remove cert | +| | `EXEC` | | Issue a new cert | +| | `EXEC` | | Upload a cert | diff --git a/docs/vercel-docs/providers/vercel/certs/index.md b/docs/vercel-docs/providers/vercel/certs/index.md index 45c96f7b78..ecb7f5972b 100644 --- a/docs/vercel-docs/providers/vercel/certs/index.md +++ b/docs/vercel-docs/providers/vercel/certs/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Certs :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/checks/deployments/index.md b/docs/vercel-docs/providers/vercel/checks/deployments/index.md index fb2e2f8870..0690c80723 100644 --- a/docs/vercel-docs/providers/vercel/checks/deployments/index.md +++ b/docs/vercel-docs/providers/vercel/checks/deployments/index.md @@ -14,41 +14,44 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeployments
TypeResource
Idvercel.checks.deployments
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `blocking` | `boolean` | -| `completedAt` | `number` | -| `conclusion` | `string` | -| `createdAt` | `number` | -| `deploymentId` | `string` | -| `detailsUrl` | `string` | -| `externalId` | `string` | -| `integrationId` | `string` | -| `output` | `object` | -| `path` | `string` | -| `rerequestable` | `boolean` | -| `startedAt` | `number` | -| `status` | `string` | -| `updatedAt` | `number` | +| | `string` | +| | `string` | +| | `boolean` | +| | `number` | +| | `string` | +| | `number` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `boolean` | +| | `number` | +| | `string` | +| | `number` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_all_checks` | `SELECT` | `deploymentId, teamId` | List all of the checks created for a deployment. | -| `get_check` | `SELECT` | `checkId, deploymentId, teamId` | Return a detailed response for a single check. | -| `create_check` | `INSERT` | `deploymentId, teamId, data__blocking, data__name` | Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error. | -| `_get_all_checks` | `EXEC` | `deploymentId, teamId` | List all of the checks created for a deployment. | -| `rerequest_check` | `EXEC` | `checkId, deploymentId, teamId` | Rerequest a selected check that has failed. | -| `update_check` | `EXEC` | `checkId, deploymentId, teamId` | Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error. | +| | `SELECT` | | List all of the checks created for a deployment. | +| | `SELECT` | | Return a detailed response for a single check. | +| | `INSERT` | | Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error. | +| | `EXEC` | | List all of the checks created for a deployment. | +| | `EXEC` | | Rerequest a selected check that has failed. | +| | `EXEC` | | Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error. | diff --git a/docs/vercel-docs/providers/vercel/checks/index.md b/docs/vercel-docs/providers/vercel/checks/index.md index f0d3fc23d1..57d7ff3216 100644 --- a/docs/vercel-docs/providers/vercel/checks/index.md +++ b/docs/vercel-docs/providers/vercel/checks/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Checks :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/deployments/builds/index.md b/docs/vercel-docs/providers/vercel/deployments/builds/index.md index 62fb800899..d73d966431 100644 --- a/docs/vercel-docs/providers/vercel/deployments/builds/index.md +++ b/docs/vercel-docs/providers/vercel/deployments/builds/index.md @@ -14,35 +14,38 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namebuilds
TypeResource
Idvercel.deployments.builds
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the Build | -| `config` | `object` | An object that contains the Build's configuration | -| `copiedFrom` | `string` | | -| `createdAt` | `number` | The time at which the Build was created | -| `createdIn` | `string` | The region where the Build was first created | -| `deployedAt` | `number` | The time at which the Build was deployed | -| `deploymentId` | `string` | The unique identifier of the deployment | -| `entrypoint` | `string` | The entrypoint of the deployment | -| `fingerprint` | `string` | If the Build uses the `@vercel/static` Runtime, it contains a hashed string of all outputs | -| `output` | `array` | A list of outputs for the Build that can be either Serverless Functions or static files | -| `readyState` | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | -| `readyStateAt` | `number` | The time at which the Build state was last modified | -| `scheduledAt` | `number` | The time at which the Build was scheduled to be built | -| `use` | `string` | The Runtime the Build used to generate the output | +| | `string` | The unique identifier of the Build | +| | `object` | An object that contains the Build's configuration | +| | `string` | | +| | `number` | The time at which the Build was created | +| | `string` | The region where the Build was first created | +| | `number` | The time at which the Build was deployed | +| | `string` | The unique identifier of the deployment | +| | `string` | The entrypoint of the deployment | +| | `string` | If the Build uses the `@vercel/static` Runtime, it contains a hashed string of all outputs | +| | `array` | A list of outputs for the Build that can be either Serverless Functions or static files | +| | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | +| | `number` | The time at which the Build state was last modified | +| | `number` | The time at which the Build was scheduled to be built | +| | `string` | The Runtime the Build used to generate the output | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_builds_for_deployment` | `SELECT` | `deploymentId` | -| `_get_builds_for_deployment` | `EXEC` | `deploymentId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/vercel-docs/providers/vercel/deployments/deployments/index.md b/docs/vercel-docs/providers/vercel/deployments/deployments/index.md index 7040f4a316..9cf9dc83c6 100644 --- a/docs/vercel-docs/providers/vercel/deployments/deployments/index.md +++ b/docs/vercel-docs/providers/vercel/deployments/deployments/index.md @@ -14,113 +14,116 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeployments
TypeResource
Idvercel.deployments.deployments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A string holding the unique ID of the deployment | -| `name` | `string` | The name of the project associated with the deployment at the time that the deployment was created | -| `_alias` | `array` | A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation | -| `_aliasAssigned` | `boolean` | A boolean that will be true when the aliases from the alias property were assigned successfully | -| `_aliasError` | `object` | An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` | -| `_aliasFinal` | `string` | | -| `_aliasWarning` | `object` | | -| `_autoAssignCustomDomains` | `boolean` | | -| `_automaticAliases` | `array` | | -| `_bootedAt` | `number` | | -| `_buildErrorAt` | `number` | | -| `_buildingAt` | `number` | | -| `_canceledAt` | `number` | | -| `_checksConclusion` | `string` | | -| `_checksState` | `string` | | -| `_createdAt` | `number` | A number containing the date when the deployment was created in milliseconds | -| `_creator` | `object` | Information about the deployment creator | -| `_errorCode` | `string` | | -| `_errorLink` | `string` | | -| `_errorMessage` | `string` | | -| `_errorStep` | `string` | | -| `_gitSource` | `` | | -| `_id` | `string` | A string holding the unique ID of the deployment | -| `_lambdas` | `array` | | -| `_meta` | `object` | An object containing the deployment's metadata | -| `_name` | `string` | The name of the project associated with the deployment at the time that the deployment was created | -| `_previewCommentsEnabled` | `boolean` | Whether or not preview comments are enabled for the deployment | -| `_public` | `boolean` | A boolean representing if the deployment is public or not. By default this is `false` | -| `_readyState` | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | -| `_readySubstate` | `string` | The substate of the deployment when the state is "READY" | -| `_regions` | `array` | The regions the deployment exists in | -| `_source` | `string` | Where was the deployment created from | -| `_target` | `string` | If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned | -| `_team` | `object` | The team that owns the deployment if any | -| `_type` | `string` | | -| `_url` | `string` | A string with the unique URL of the deployment | -| `_userAliases` | `array` | An array of domains that were provided by the user when creating the Deployment. | -| `_version` | `number` | The platform version that was used to create the deployment. | -| `alias` | `array` | A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation | -| `aliasAssigned` | `boolean` | A boolean that will be true when the aliases from the alias property were assigned successfully | -| `aliasAssignedAt` | `` | | -| `aliasError` | `object` | An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` | -| `aliasFinal` | `string` | | -| `aliasWarning` | `object` | | -| `autoAssignCustomDomains` | `boolean` | | -| `automaticAliases` | `array` | | -| `bootedAt` | `number` | | -| `build` | `object` | | -| `buildErrorAt` | `number` | | -| `buildingAt` | `number` | | -| `builds` | `array` | | -| `canceledAt` | `number` | | -| `checksConclusion` | `string` | | -| `checksState` | `string` | | -| `connectBuildsEnabled` | `boolean` | The flag saying if Vercel Connect configuration is used for builds | -| `connectConfigurationId` | `string` | The ID of Vercel Connect configuration used for this deployment | -| `createdAt` | `number` | A number containing the date when the deployment was created in milliseconds | -| `createdIn` | `string` | The region where the deployment was first created | -| `creator` | `object` | Information about the deployment creator | -| `env` | `array` | The keys of the environment variables that were assigned during runtime | -| `errorCode` | `string` | | -| `errorLink` | `string` | | -| `errorMessage` | `string` | | -| `errorStep` | `string` | | -| `functions` | `object` | An object used to configure your Serverless Functions | -| `gitRepo` | `` | | -| `gitSource` | `` | | -| `inspectorUrl` | `string` | Vercel URL to inspect the deployment. | -| `isInConcurrentBuildsQueue` | `boolean` | Is the deployment currently queued waiting for a Concurrent Build Slot to be available | -| `lambdas` | `array` | | -| `meta` | `object` | An object containing the deployment's metadata | -| `monorepoManager` | `string` | An monorepo manager that was used for the deployment | -| `ownerId` | `string` | The unique ID of the user or team the deployment belongs to | -| `plan` | `string` | The pricing plan the deployment was made under | -| `previewCommentsEnabled` | `boolean` | Whether or not preview comments are enabled for the deployment | -| `projectId` | `string` | The ID of the project the deployment is associated with | -| `public` | `boolean` | A boolean representing if the deployment is public or not. By default this is `false` | -| `readyState` | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | -| `readySubstate` | `string` | The substate of the deployment when the state is "READY" | -| `regions` | `array` | The regions the deployment exists in | -| `routes` | `array` | A list of routes objects used to rewrite paths to point towards other internal or external paths | -| `source` | `string` | Where was the deployment created from | -| `target` | `string` | If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned | -| `team` | `object` | The team that owns the deployment if any | -| `type` | `string` | | -| `url` | `string` | A string with the unique URL of the deployment | -| `userAliases` | `array` | An array of domains that were provided by the user when creating the Deployment. | -| `version` | `number` | The platform version that was used to create the deployment. | +| | `string` | A string holding the unique ID of the deployment | +| | `string` | The name of the project associated with the deployment at the time that the deployment was created | +| | `array` | A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation | +| | `boolean` | A boolean that will be true when the aliases from the alias property were assigned successfully | +| | `object` | An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` | +| | `string` | | +| | `object` | | +| | `boolean` | | +| | `array` | | +| | `number` | | +| | `number` | | +| | `number` | | +| | `number` | | +| | `string` | | +| | `string` | | +| | `number` | A number containing the date when the deployment was created in milliseconds | +| | `object` | Information about the deployment creator | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `` | | +| | `string` | A string holding the unique ID of the deployment | +| | `array` | | +| | `object` | An object containing the deployment's metadata | +| | `string` | The name of the project associated with the deployment at the time that the deployment was created | +| | `boolean` | Whether or not preview comments are enabled for the deployment | +| | `boolean` | A boolean representing if the deployment is public or not. By default this is `false` | +| | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | +| | `string` | The substate of the deployment when the state is "READY" | +| | `array` | The regions the deployment exists in | +| | `string` | Where was the deployment created from | +| | `string` | If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned | +| | `object` | The team that owns the deployment if any | +| | `string` | | +| | `string` | A string with the unique URL of the deployment | +| | `array` | An array of domains that were provided by the user when creating the Deployment. | +| | `number` | The platform version that was used to create the deployment. | +| | `array` | A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation | +| | `boolean` | A boolean that will be true when the aliases from the alias property were assigned successfully | +| | `` | | +| | `object` | An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` | +| | `string` | | +| | `object` | | +| | `boolean` | | +| | `array` | | +| | `number` | | +| | `object` | | +| | `number` | | +| | `number` | | +| | `array` | | +| | `number` | | +| | `string` | | +| | `string` | | +| | `boolean` | The flag saying if Vercel Connect configuration is used for builds | +| | `string` | The ID of Vercel Connect configuration used for this deployment | +| | `number` | A number containing the date when the deployment was created in milliseconds | +| | `string` | The region where the deployment was first created | +| | `object` | Information about the deployment creator | +| | `array` | The keys of the environment variables that were assigned during runtime | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `object` | An object used to configure your Serverless Functions | +| | `` | | +| | `` | | +| | `string` | Vercel URL to inspect the deployment. | +| | `boolean` | Is the deployment currently queued waiting for a Concurrent Build Slot to be available | +| | `array` | | +| | `object` | An object containing the deployment's metadata | +| | `string` | An monorepo manager that was used for the deployment | +| | `string` | The unique ID of the user or team the deployment belongs to | +| | `string` | The pricing plan the deployment was made under | +| | `boolean` | Whether or not preview comments are enabled for the deployment | +| | `string` | The ID of the project the deployment is associated with | +| | `boolean` | A boolean representing if the deployment is public or not. By default this is `false` | +| | `string` | The state of the deployment depending on the process of deploying, or if it is ready or in an error state | +| | `string` | The substate of the deployment when the state is "READY" | +| | `array` | The regions the deployment exists in | +| | `array` | A list of routes objects used to rewrite paths to point towards other internal or external paths | +| | `string` | Where was the deployment created from | +| | `string` | If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned | +| | `object` | The team that owns the deployment if any | +| | `string` | | +| | `string` | A string with the unique URL of the deployment | +| | `array` | An array of domains that were provided by the user when creating the Deployment. | +| | `number` | The platform version that was used to create the deployment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_deployment` | `SELECT` | `idOrUrl, teamId` | Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment. | -| `get_deployments` | `SELECT` | `teamId` | List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`. | -| `create_deployment` | `INSERT` | `teamId, data__branch, data__connection_uris, data__database, data__databases, data__endpoint, data__endpoints, data__name, data__pagination, data__password, data__project, data__projects, data__role, data__roles` | Create a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request, either referenced or inlined. Additionally, a deployment id can be specified to redeploy a previous deployment. | -| `delete_deployment` | `DELETE` | `id, teamId` | This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments. | -| `_get_deployments` | `EXEC` | `teamId` | List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`. | -| `cancel_deployment` | `EXEC` | `id, teamId` | This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL. | +| | `SELECT` | | Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment. | +| | `SELECT` | | List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`. | +| | `INSERT` | | Create a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request, either referenced or inlined. Additionally, a deployment id can be specified to redeploy a previous deployment. | +| | `DELETE` | | This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments. | +| | `EXEC` | | List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`. | +| | `EXEC` | | This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL. | diff --git a/docs/vercel-docs/providers/vercel/deployments/events/index.md b/docs/vercel-docs/providers/vercel/deployments/events/index.md index 647ecfc415..5d3ab85fe9 100644 --- a/docs/vercel-docs/providers/vercel/deployments/events/index.md +++ b/docs/vercel-docs/providers/vercel/deployments/events/index.md @@ -14,29 +14,32 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevents
TypeResource
Idvercel.deployments.events
Id
## Fields | Name | Datatype | |:-----|:---------| -| `__created` | `number` | -| `__payload` | `object` | -| `__type` | `string` | -| `_created` | `number` | -| `_payload` | `object` | -| `_type` | `string` | -| `created` | `number` | -| `payload` | `object` | -| `type` | `string` | +| | `number` | +| | `object` | +| | `string` | +| | `number` | +| | `object` | +| | `string` | +| | `number` | +| | `object` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_deployment_events` | `SELECT` | `idOrUrl, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/deployments/files/index.md b/docs/vercel-docs/providers/vercel/deployments/files/index.md index f534ed512c..c20adb5de5 100644 --- a/docs/vercel-docs/providers/vercel/deployments/files/index.md +++ b/docs/vercel-docs/providers/vercel/deployments/files/index.md @@ -14,29 +14,32 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefiles
TypeResource
Idvercel.deployments.files
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the file tree entry | -| `children` | `array` | The list of children files of the directory (only valid for the `directory` type) | -| `contentType` | `string` | The content-type of the file (only valid for the `file` type) | -| `mode` | `number` | The file "mode" indicating file type and permissions. | -| `symlink` | `string` | Not currently used. See `file-list-to-tree.ts`. | -| `type` | `string` | String indicating the type of file tree entry. | -| `uid` | `string` | The unique identifier of the file (only valid for the `file` type) | +| | `string` | The name of the file tree entry | +| | `array` | The list of children files of the directory (only valid for the `directory` type) | +| | `string` | The content-type of the file (only valid for the `file` type) | +| | `number` | The file "mode" indicating file type and permissions. | +| | `string` | Not currently used. See `file-list-to-tree.ts`. | +| | `string` | String indicating the type of file tree entry. | +| | `string` | The unique identifier of the file (only valid for the `file` type) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_deployment_files` | `SELECT` | `id, teamId` | Allows to retrieve the file structure of a deployment by supplying the deployment unique identifier. | -| `get_deployment_file_contents` | `EXEC` | `fileId, id, teamId` | Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain the raw content of the file. | -| `upload_file` | `EXEC` | `teamId` | Before you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once that's completed, you can create a new deployment with the uploaded files. The file content must be placed inside the body of the request. In the case of a successful response you'll receive a status code 200 with an empty body. | +| | `SELECT` | | Allows to retrieve the file structure of a deployment by supplying the deployment unique identifier. | +| | `EXEC` | | Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain the raw content of the file. | +| | `EXEC` | | Before you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once that's completed, you can create a new deployment with the uploaded files. The file content must be placed inside the body of the request. In the case of a successful response you'll receive a status code 200 with an empty body. | diff --git a/docs/vercel-docs/providers/vercel/deployments/index.md b/docs/vercel-docs/providers/vercel/deployments/index.md index f655e98b00..d070892a5d 100644 --- a/docs/vercel-docs/providers/vercel/deployments/index.md +++ b/docs/vercel-docs/providers/vercel/deployments/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Deployments :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/dns/domains_records/index.md b/docs/vercel-docs/providers/vercel/dns/domains_records/index.md index c6aa763a38..d8fb20dd62 100644 --- a/docs/vercel-docs/providers/vercel/dns/domains_records/index.md +++ b/docs/vercel-docs/providers/vercel/dns/domains_records/index.md @@ -14,36 +14,39 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains_records
TypeResource
Idvercel.dns.domains_records
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `created` | `number` | -| `createdAt` | `number` | -| `creator` | `string` | -| `mxPriority` | `number` | -| `priority` | `number` | -| `slug` | `string` | -| `type` | `string` | -| `updated` | `number` | -| `updatedAt` | `number` | -| `value` | `string` | +| | `string` | +| | `string` | +| | `number` | +| | `number` | +| | `string` | +| | `number` | +| | `number` | +| | `string` | +| | `string` | +| | `number` | +| | `number` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_records` | `SELECT` | `domain, teamId` | Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options. | -| `create_record` | `INSERT` | `domain, teamId, data__type` | Creates a DNS record for a domain. | -| `remove_record` | `DELETE` | `domain, recordId, teamId` | Removes an existing DNS record from a domain name. | -| `_get_records` | `EXEC` | `domain, teamId` | Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options. | -| `update_record` | `EXEC` | `recordId, teamId` | Updates an existing DNS record for a domain name. | +| | `SELECT` | | Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options. | +| | `INSERT` | | Creates a DNS record for a domain. | +| | `DELETE` | | Removes an existing DNS record from a domain name. | +| | `EXEC` | | Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options. | +| | `EXEC` | | Updates an existing DNS record for a domain name. | diff --git a/docs/vercel-docs/providers/vercel/dns/index.md b/docs/vercel-docs/providers/vercel/dns/index.md index e7c50e7c73..9e94b2086e 100644 --- a/docs/vercel-docs/providers/vercel/dns/index.md +++ b/docs/vercel-docs/providers/vercel/dns/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Dns :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/domains/config/index.md b/docs/vercel-docs/providers/vercel/domains/config/index.md index e49e4d1a87..871fa71368 100644 --- a/docs/vercel-docs/providers/vercel/domains/config/index.md +++ b/docs/vercel-docs/providers/vercel/domains/config/index.md @@ -14,23 +14,26 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfig
TypeResource
Idvercel.domains.config
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `acceptedChallenges` | `array` | Which challenge types the domain can use for issuing certs. | -| `configuredBy` | `string` | How we see the domain's configuration. - `CNAME`: Domain has a CNAME pointing to Vercel. - `A`: Domain's A record is resolving to Vercel. - `http`: Domain is resolving to Vercel but may be behind a Proxy. - `null`: Domain is not resolving to Vercel. | -| `misconfigured` | `boolean` | Whether or not the domain is configured AND we can automatically generate a TLS certificate. | +| | `array` | Which challenge types the domain can use for issuing certs. | +| | `string` | How we see the domain's configuration. - `CNAME`: Domain has a CNAME pointing to Vercel. - `A`: Domain's A record is resolving to Vercel. - `http`: Domain is resolving to Vercel but may be behind a Proxy. - `null`: Domain is not resolving to Vercel. | +| | `boolean` | Whether or not the domain is configured AND we can automatically generate a TLS certificate. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_domain_config` | `SELECT` | `domain, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/domains/domain_registry/index.md b/docs/vercel-docs/providers/vercel/domains/domain_registry/index.md index 08a25a6c62..d3b20737bd 100644 --- a/docs/vercel-docs/providers/vercel/domains/domain_registry/index.md +++ b/docs/vercel-docs/providers/vercel/domains/domain_registry/index.md @@ -14,24 +14,27 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomain_registry
TypeResource
Idvercel.domains.domain_registry
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `reason` | `string` | Description associated with transferable state. | -| `status` | `string` | The current state of an ongoing transfer. `pending_owner`: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. `pending_admin`: Waiting for approval by Vercel Registrar admin. `pending_registry`: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). `completed`: The transfer completed successfully. `cancelled`: The transfer was cancelled. `undef`: No transfer exists for this domain. `unknown`: This TLD is not supported by Vercel's Registrar. | -| `transferPolicy` | `string` | The domain's transfer policy (depends on TLD requirements). `charge-and-renew`: transfer will charge for renewal and will renew the existing domain's registration. `no-charge-no-change`: transfer will have no change to registration period and does not require charge. `no-change`: transfer charge is required, but no change in registration period. `new-term`: transfer charge is required and a new registry term is set based on the transfer date. `not-supported`: transfers are not supported for this domain or TLD. `null`: This TLD is not supported by Vercel's Registrar. | -| `transferable` | `boolean` | Whether or not the domain is transferable | +| | `string` | Description associated with transferable state. | +| | `string` | The current state of an ongoing transfer. `pending_owner`: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. `pending_admin`: Waiting for approval by Vercel Registrar admin. `pending_registry`: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). `completed`: The transfer completed successfully. `cancelled`: The transfer was cancelled. `undef`: No transfer exists for this domain. `unknown`: This TLD is not supported by Vercel's Registrar. | +| | `string` | The domain's transfer policy (depends on TLD requirements). `charge-and-renew`: transfer will charge for renewal and will renew the existing domain's registration. `no-charge-no-change`: transfer will have no change to registration period and does not require charge. `no-change`: transfer charge is required, but no change in registration period. `new-term`: transfer charge is required and a new registry term is set based on the transfer date. `not-supported`: transfers are not supported for this domain or TLD. `null`: This TLD is not supported by Vercel's Registrar. | +| | `boolean` | Whether or not the domain is transferable | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_domain_transfer` | `SELECT` | `domain, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/domains/domains/index.md b/docs/vercel-docs/providers/vercel/domains/domains/index.md index 00eb6c681c..d6b6187689 100644 --- a/docs/vercel-docs/providers/vercel/domains/domains/index.md +++ b/docs/vercel-docs/providers/vercel/domains/domains/index.md @@ -14,43 +14,46 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Idvercel.domains.domains
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the domain. | -| `name` | `string` | The domain name. | -| `boughtAt` | `number` | If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. | -| `createdAt` | `number` | Timestamp in milliseconds when the domain was created in the registry. | -| `creator` | `object` | An object containing information of the domain creator, including the user's id, username, and email. | -| `customNameservers` | `array` | A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. | -| `expiresAt` | `number` | Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel. | -| `intendedNameservers` | `array` | A list of the intended nameservers for the domain to point to Vercel DNS. | -| `nameservers` | `array` | A list of the current nameservers of the domain. | -| `orderedAt` | `number` | Timestamp in milliseconds at which the domain was ordered. | -| `renew` | `boolean` | Indicates whether the domain is set to automatically renew. | -| `serviceType` | `string` | The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. | -| `suffix` | `boolean` | | -| `transferStartedAt` | `number` | If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. | -| `transferredAt` | `number` | Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. | -| `verified` | `boolean` | If the domain has the ownership verified. | +| | `string` | The unique identifier of the domain. | +| | `string` | The domain name. | +| | `number` | If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. | +| | `number` | Timestamp in milliseconds when the domain was created in the registry. | +| | `object` | An object containing information of the domain creator, including the user's id, username, and email. | +| | `array` | A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. | +| | `number` | Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel. | +| | `array` | A list of the intended nameservers for the domain to point to Vercel DNS. | +| | `array` | A list of the current nameservers of the domain. | +| | `number` | Timestamp in milliseconds at which the domain was ordered. | +| | `boolean` | Indicates whether the domain is set to automatically renew. | +| | `string` | The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. | +| | `boolean` | | +| | `number` | If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. | +| | `number` | Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. | +| | `boolean` | If the domain has the ownership verified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_domain` | `SELECT` | `domain, teamId` | Get information for a single domain in an account or team. | -| `get_domains` | `SELECT` | `teamId` | Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided. | -| `create_or_transfer_domain` | `INSERT` | `teamId` | This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel. | -| `delete_domain` | `DELETE` | `domain, teamId` | Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. | -| `_get_domain` | `EXEC` | `domain, teamId` | Get information for a single domain in an account or team. | -| `_get_domains` | `EXEC` | `teamId` | Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided. | -| `buy_domain` | `EXEC` | `teamId, data__name` | Allows to purchase the specified domain. | -| `patch_domain` | `EXEC` | `domain, teamId` | Update or move apex domain. | +| | `SELECT` | | Get information for a single domain in an account or team. | +| | `SELECT` | | Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided. | +| | `INSERT` | | This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel. | +| | `DELETE` | | Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. | +| | `EXEC` | | Get information for a single domain in an account or team. | +| | `EXEC` | | Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided. | +| | `EXEC` | | Allows to purchase the specified domain. | +| | `EXEC` | | Update or move apex domain. | diff --git a/docs/vercel-docs/providers/vercel/domains/index.md b/docs/vercel-docs/providers/vercel/domains/index.md index 403252d5a4..27b7c57cf4 100644 --- a/docs/vercel-docs/providers/vercel/domains/index.md +++ b/docs/vercel-docs/providers/vercel/domains/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Domains :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/domains/price/index.md b/docs/vercel-docs/providers/vercel/domains/price/index.md index 3550d9ebe2..e62a6bdf87 100644 --- a/docs/vercel-docs/providers/vercel/domains/price/index.md +++ b/docs/vercel-docs/providers/vercel/domains/price/index.md @@ -14,22 +14,25 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprice
TypeResource
Idvercel.domains.price
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `period` | `number` | The number of years the domain could be held before paying again. | -| `price` | `number` | The domain price in USD. | +| | `number` | The number of years the domain could be held before paying again. | +| | `number` | The domain price in USD. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `check_domain_price` | `SELECT` | `name, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/domains/status/index.md b/docs/vercel-docs/providers/vercel/domains/status/index.md index 4241e2d515..6cd194ed86 100644 --- a/docs/vercel-docs/providers/vercel/domains/status/index.md +++ b/docs/vercel-docs/providers/vercel/domains/status/index.md @@ -14,18 +14,21 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestatus
TypeResource
Idvercel.domains.status
Id
## Fields ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `check_domain_status` | `SELECT` | `name, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/edge_config/edge_config/index.md b/docs/vercel-docs/providers/vercel/edge_config/edge_config/index.md index b2673c2cc4..866a3ce2e4 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/edge_config/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/edge_config/index.md @@ -14,33 +14,36 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameedge_config
TypeResource
Idvercel.edge_config.edge_config
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `createdAt` | `number` | | -| `digest` | `string` | | -| `itemCount` | `number` | | -| `ownerId` | `string` | | -| `sizeInBytes` | `number` | | -| `slug` | `string` | Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores). | -| `transfer` | `object` | Keeps track of the current state of the Edge Config while it gets transferred. | -| `updatedAt` | `number` | | +| | `string` | | +| | `number` | | +| | `string` | | +| | `number` | | +| | `string` | | +| | `number` | | +| | `string` | Name for the Edge Config Names are not unique. Must start with an alphabetic character and can contain only alphanumeric characters and underscores). | +| | `object` | Keeps track of the current state of the Edge Config while it gets transferred. | +| | `number` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_edge_config` | `SELECT` | `edgeConfigId, teamId` | Returns an Edge Config. | -| `get_edge_configs` | `SELECT` | `teamId` | Returns all Edge Configs. | -| `create_edge_config` | `INSERT` | `teamId, data__slug` | Creates an Edge Config. | -| `delete_edge_config` | `DELETE` | `edgeConfigId, teamId` | Delete an Edge Config by id. | -| `update_edge_config` | `EXEC` | `edgeConfigId, teamId, data__slug` | Updates an Edge Config. | +| | `SELECT` | | Returns an Edge Config. | +| | `SELECT` | | Returns all Edge Configs. | +| | `INSERT` | | Creates an Edge Config. | +| | `DELETE` | | Delete an Edge Config by id. | +| | `EXEC` | | Updates an Edge Config. | diff --git a/docs/vercel-docs/providers/vercel/edge_config/index.md b/docs/vercel-docs/providers/vercel/edge_config/index.md index b842c374e6..24cbe69125 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Edge-Config :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/edge_config/item/index.md b/docs/vercel-docs/providers/vercel/edge_config/item/index.md index 0484253651..b5b63750e1 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/item/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/item/index.md @@ -14,25 +14,28 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameitem
TypeResource
Idvercel.edge_config.item
Id
## Fields | Name | Datatype | |:-----|:---------| -| `createdAt` | `number` | -| `edgeConfigId` | `string` | -| `key` | `string` | -| `updatedAt` | `number` | -| `value` | `` | +| | `number` | +| | `string` | +| | `string` | +| | `number` | +| || ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_edge_config_item` | `SELECT` | `edgeConfigId, edgeConfigItemKey, teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/edge_config/items/index.md b/docs/vercel-docs/providers/vercel/edge_config/items/index.md index d42bd68eaf..6f981b21e7 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/items/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/items/index.md @@ -14,26 +14,29 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameitems
TypeResource
Idvercel.edge_config.items
Id
## Fields | Name | Datatype | |:-----|:---------| -| `createdAt` | `number` | -| `edgeConfigId` | `string` | -| `key` | `string` | -| `updatedAt` | `number` | -| `value` | `` | +| | `number` | +| | `string` | +| | `string` | +| | `number` | +| || ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_edge_config_items` | `SELECT` | `edgeConfigId, teamId` | Returns all items of an Edge Config. | -| `patcht_edge_config_items` | `EXEC` | `edgeConfigId, teamId, data__items` | Update multiple Edge Config Items in batch. | +| | `SELECT` | | Returns all items of an Edge Config. | +| | `EXEC` | | Update multiple Edge Config Items in batch. | diff --git a/docs/vercel-docs/providers/vercel/edge_config/token/index.md b/docs/vercel-docs/providers/vercel/edge_config/token/index.md index f09f9771b5..0c62597d99 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/token/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/token/index.md @@ -14,26 +14,29 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametoken
TypeResource
Idvercel.edge_config.token
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | This is not the token itself, but rather an id to identify the token by | -| `createdAt` | `number` | | -| `edgeConfigId` | `string` | | -| `label` | `string` | | -| `token` | `string` | | +| | `string` | This is not the token itself, but rather an id to identify the token by | +| | `number` | | +| | `string` | | +| | `string` | | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_edge_config_token` | `SELECT` | `edgeConfigId, teamId, token` | Return meta data about an Edge Config token. | -| `create_edge_config_token` | `INSERT` | `edgeConfigId, teamId, data__label` | Adds a token to an existing Edge Config. | +| | `SELECT` | | Return meta data about an Edge Config token. | +| | `INSERT` | | Adds a token to an existing Edge Config. | diff --git a/docs/vercel-docs/providers/vercel/edge_config/tokens/index.md b/docs/vercel-docs/providers/vercel/edge_config/tokens/index.md index 9dd82454fd..c7b0f67b9a 100644 --- a/docs/vercel-docs/providers/vercel/edge_config/tokens/index.md +++ b/docs/vercel-docs/providers/vercel/edge_config/tokens/index.md @@ -14,26 +14,29 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametokens
TypeResource
Idvercel.edge_config.tokens
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | This is not the token itself, but rather an id to identify the token by | -| `createdAt` | `number` | | -| `edgeConfigId` | `string` | | -| `label` | `string` | | -| `token` | `string` | | +| | `string` | This is not the token itself, but rather an id to identify the token by | +| | `number` | | +| | `string` | | +| | `string` | | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_edge_config_tokens` | `SELECT` | `edgeConfigId, teamId` | Returns all tokens of an Edge Config. | -| `delete_edge_config_tokens` | `DELETE` | `edgeConfigId, teamId, data__tokens` | Deletes one or more tokens of an existing Edge Config. | +| | `SELECT` | | Returns all tokens of an Edge Config. | +| | `DELETE` | | Deletes one or more tokens of an existing Edge Config. | diff --git a/docs/vercel-docs/providers/vercel/integrations/configuration/index.md b/docs/vercel-docs/providers/vercel/integrations/configuration/index.md index 463d2e482b..9ce73555c2 100644 --- a/docs/vercel-docs/providers/vercel/integrations/configuration/index.md +++ b/docs/vercel-docs/providers/vercel/integrations/configuration/index.md @@ -14,66 +14,69 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfiguration
TypeResource
Idvercel.integrations.configuration
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the configuration | -| `_completedAt` | `number` | A timestamp that tells you when the configuration was installed successfully | -| `_createdAt` | `number` | A timestamp that tells you when the configuration was created | -| `_deletedAt` | `number` | A timestamp that tells you when the configuration was updated. | -| `_disabledAt` | `number` | A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team. | -| `_disabledReason` | `string` | | -| `_id` | `string` | The unique identifier of the configuration | -| `_integrationId` | `string` | The unique identifier of the app the configuration was created for | -| `_ownerId` | `string` | The user or team ID that owns the configuration | -| `_projects` | `array` | When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. | -| `_removedLogDrainsAt` | `number` | | -| `_removedProjectEnvsAt` | `number` | | -| `_removedTokensAt` | `number` | | -| `_removedWebhooksAt` | `number` | | -| `_scopes` | `array` | The resources that are allowed to be accessed by the configuration. | -| `_scopesQueue` | `array` | | -| `_slug` | `string` | The slug of the integration the configuration is created for. | -| `_source` | `string` | Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. | -| `_teamId` | `string` | When the configuration was created for a team, this will show the ID of the team. | -| `_type` | `string` | | -| `_updatedAt` | `number` | A timestamp that tells you when the configuration was updated. | -| `_userId` | `string` | The ID of the user that created the configuration. | -| `canConfigureOpenTelemetry` | `boolean` | | -| `completedAt` | `number` | A timestamp that tells you when the configuration was installed successfully | -| `createdAt` | `number` | A timestamp that tells you when the configuration was created | -| `deletedAt` | `number` | A timestamp that tells you when the configuration was updated. | -| `disabledAt` | `number` | A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team. | -| `disabledReason` | `string` | | -| `integrationId` | `string` | The unique identifier of the app the configuration was created for | -| `ownerId` | `string` | The user or team ID that owns the configuration | -| `projectSelection` | `string` | A string representing the permission for projects. Possible values are `all` or `selected`. | -| `projects` | `array` | When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. | -| `removedLogDrainsAt` | `number` | | -| `removedProjectEnvsAt` | `number` | | -| `removedTokensAt` | `number` | | -| `removedWebhooksAt` | `number` | | -| `scopes` | `array` | The resources that are allowed to be accessed by the configuration. | -| `scopesQueue` | `array` | | -| `slug` | `string` | The slug of the integration the configuration is created for. | -| `source` | `string` | Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. | -| `teamId` | `string` | When the configuration was created for a team, this will show the ID of the team. | -| `type` | `string` | | -| `updatedAt` | `number` | A timestamp that tells you when the configuration was updated. | -| `userId` | `string` | The ID of the user that created the configuration. | +| | `string` | The unique identifier of the configuration | +| | `number` | A timestamp that tells you when the configuration was installed successfully | +| | `number` | A timestamp that tells you when the configuration was created | +| | `number` | A timestamp that tells you when the configuration was updated. | +| | `number` | A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team. | +| | `string` | | +| | `string` | The unique identifier of the configuration | +| | `string` | The unique identifier of the app the configuration was created for | +| | `string` | The user or team ID that owns the configuration | +| | `array` | When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. | +| | `number` | | +| | `number` | | +| | `number` | | +| | `number` | | +| | `array` | The resources that are allowed to be accessed by the configuration. | +| | `array` | | +| | `string` | The slug of the integration the configuration is created for. | +| | `string` | Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. | +| | `string` | When the configuration was created for a team, this will show the ID of the team. | +| | `string` | | +| | `number` | A timestamp that tells you when the configuration was updated. | +| | `string` | The ID of the user that created the configuration. | +| | `boolean` | | +| | `number` | A timestamp that tells you when the configuration was installed successfully | +| | `number` | A timestamp that tells you when the configuration was created | +| | `number` | A timestamp that tells you when the configuration was updated. | +| | `number` | A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team. | +| | `string` | | +| | `string` | The unique identifier of the app the configuration was created for | +| | `string` | The user or team ID that owns the configuration | +| | `string` | A string representing the permission for projects. Possible values are `all` or `selected`. | +| | `array` | When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. | +| | `number` | | +| | `number` | | +| | `number` | | +| | `number` | | +| | `array` | The resources that are allowed to be accessed by the configuration. | +| | `array` | | +| | `string` | The slug of the integration the configuration is created for. | +| | `string` | Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. | +| | `string` | When the configuration was created for a team, this will show the ID of the team. | +| | `string` | | +| | `number` | A timestamp that tells you when the configuration was updated. | +| | `string` | The ID of the user that created the configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_configuration` | `SELECT` | `id, teamId` | Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it. | -| `get_configurations` | `SELECT` | `teamId, view` | Allows to retrieve all configurations for an authenticated integration. When the `project` view is used, configurations generated for the authorization flow will be filtered out of the results. | -| `delete_configuration` | `DELETE` | `id, teamId` | Allows to remove the configuration with the `id` provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables. | +| | `SELECT` | | Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it. | +| | `SELECT` | | Allows to retrieve all configurations for an authenticated integration. When the `project` view is used, configurations generated for the authorization flow will be filtered out of the results. | +| | `DELETE` | | Allows to remove the configuration with the `id` provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables. | diff --git a/docs/vercel-docs/providers/vercel/integrations/git_namespaces/index.md b/docs/vercel-docs/providers/vercel/integrations/git_namespaces/index.md index 4dd076dae3..5124e54615 100644 --- a/docs/vercel-docs/providers/vercel/integrations/git_namespaces/index.md +++ b/docs/vercel-docs/providers/vercel/integrations/git_namespaces/index.md @@ -14,28 +14,31 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namegit_namespaces
TypeResource
Idvercel.integrations.git_namespaces
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `` | -| `name` | `string` | -| `installationId` | `number` | -| `isAccessRestricted` | `boolean` | -| `ownerType` | `string` | -| `provider` | `string` | -| `requireReauth` | `boolean` | -| `slug` | `string` | +| || +| | `string` | +| | `number` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `git_namespaces` | `SELECT` | `teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/integrations/index.md b/docs/vercel-docs/providers/vercel/integrations/index.md index e1e2d0e247..3fbcad43e3 100644 --- a/docs/vercel-docs/providers/vercel/integrations/index.md +++ b/docs/vercel-docs/providers/vercel/integrations/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Integrations :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/integrations/search_repo/index.md b/docs/vercel-docs/providers/vercel/integrations/search_repo/index.md index bef85bf7d7..5cafd241fa 100644 --- a/docs/vercel-docs/providers/vercel/integrations/search_repo/index.md +++ b/docs/vercel-docs/providers/vercel/integrations/search_repo/index.md @@ -14,22 +14,25 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesearch_repo
TypeResource
Idvercel.integrations.search_repo
Id
## Fields | Name | Datatype | |:-----|:---------| -| `gitAccount` | `object` | -| `repos` | `array` | +| | `object` | +| | `array` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `git_namespaces` | `SELECT` | `teamId` | +| | `SELECT` | | diff --git a/docs/vercel-docs/providers/vercel/log_drains/index.md b/docs/vercel-docs/providers/vercel/log_drains/index.md index 9bc08ebfc7..4de2a24df2 100644 --- a/docs/vercel-docs/providers/vercel/log_drains/index.md +++ b/docs/vercel-docs/providers/vercel/log_drains/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + LogDrains :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/log_drains/integrations/index.md b/docs/vercel-docs/providers/vercel/log_drains/integrations/index.md index 9dbbb282f4..699dbf5485 100644 --- a/docs/vercel-docs/providers/vercel/log_drains/integrations/index.md +++ b/docs/vercel-docs/providers/vercel/log_drains/integrations/index.md @@ -14,37 +14,40 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameintegrations
TypeResource
Idvercel.log_drains.integrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the log drain. Always prefixed with `ld_` | -| `name` | `string` | The name of the log drain | -| `branch` | `string` | The branch regexp of log drain | -| `clientId` | `string` | The oauth2 client application id that created this log drain | -| `configurationId` | `string` | The client configuration this log drain was created with | -| `createdAt` | `number` | A timestamp that tells you when the log drain was created | -| `createdFrom` | `string` | Whether the log drain was created by an integration or by a user | -| `deliveryFormat` | `string` | The delivery log format | -| `environment` | `string` | The environment of log drain | -| `headers` | `object` | The headers to send with the request | -| `ownerId` | `string` | The identifier of the team or user whose events will trigger the log drain | -| `projectId` | `string` | | -| `projectIds` | `array` | The identifier of the projects this log drain is associated with | -| `sources` | `array` | The sources from which logs are currently being delivered to this log drain. | -| `url` | `string` | The URL to call when logs are generated | +| | `string` | The unique identifier of the log drain. Always prefixed with `ld_` | +| | `string` | The name of the log drain | +| | `string` | The branch regexp of log drain | +| | `string` | The oauth2 client application id that created this log drain | +| | `string` | The client configuration this log drain was created with | +| | `number` | A timestamp that tells you when the log drain was created | +| | `string` | Whether the log drain was created by an integration or by a user | +| | `string` | The delivery log format | +| | `string` | The environment of log drain | +| | `object` | The headers to send with the request | +| | `string` | The identifier of the team or user whose events will trigger the log drain | +| | `string` | | +| | `array` | The identifier of the projects this log drain is associated with | +| | `array` | The sources from which logs are currently being delivered to this log drain. | +| | `string` | The URL to call when logs are generated | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_integration_log_drains` | `SELECT` | `teamId` | Retrieves a list of all Integration log drains that are defined for the authenticated user or team. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration. | -| `create_log_drain` | `INSERT` | `teamId, data__name, data__url` | Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error. | -| `delete_integration_log_drain` | `DELETE` | `id, teamId` | Deletes the Integration log drain with the provided `id`. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it. | +| | `SELECT` | | Retrieves a list of all Integration log drains that are defined for the authenticated user or team. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration. | +| | `INSERT` | | Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error. | +| | `DELETE` | | Deletes the Integration log drain with the provided `id`. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it. | diff --git a/docs/vercel-docs/providers/vercel/log_drains/log_drains/index.md b/docs/vercel-docs/providers/vercel/log_drains/log_drains/index.md index ad955e2d52..15ad1802a8 100644 --- a/docs/vercel-docs/providers/vercel/log_drains/log_drains/index.md +++ b/docs/vercel-docs/providers/vercel/log_drains/log_drains/index.md @@ -14,44 +14,47 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_drains
TypeResource
Idvercel.log_drains.log_drains
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `branch` | `string` | -| `clientId` | `string` | -| `configurationId` | `string` | -| `createdAt` | `number` | -| `createdFrom` | `string` | -| `deliveryFormat` | `string` | -| `disabledAt` | `number` | -| `disabledBy` | `string` | -| `disabledReason` | `string` | -| `environment` | `string` | -| `firstErrorTimestamp` | `number` | -| `headers` | `object` | -| `ownerId` | `string` | -| `projectIds` | `array` | -| `secret` | `string` | -| `sources` | `array` | -| `status` | `string` | -| `teamId` | `string` | -| `url` | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `number` | +| | `string` | +| | `string` | +| | `number` | +| | `string` | +| | `string` | +| | `string` | +| | `number` | +| | `object` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_configurable_log_drain` | `SELECT` | `id, teamId` | Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. | -| `get_configurable_log_drains` | `SELECT` | `teamId` | Retrieves a list of Configurable Log Drains. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. | -| `create_configurable_log_drain` | `INSERT` | `teamId, data__deliveryFormat, data__sources, data__url` | Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed) | -| `delete_configurable_log_drain` | `DELETE` | `id, teamId` | Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted. | +| | `SELECT` | | Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. | +| | `SELECT` | | Retrieves a list of Configurable Log Drains. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. | +| | `INSERT` | | Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed) | +| | `DELETE` | | Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted. | diff --git a/docs/vercel-docs/providers/vercel/project_members/index.md b/docs/vercel-docs/providers/vercel/project_members/index.md index 362c5b0c4e..815370c289 100644 --- a/docs/vercel-docs/providers/vercel/project_members/index.md +++ b/docs/vercel-docs/providers/vercel/project_members/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + ProjectMembers :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/project_members/projects_members/index.md b/docs/vercel-docs/providers/vercel/project_members/projects_members/index.md index 88ee905027..69a09ac110 100644 --- a/docs/vercel-docs/providers/vercel/project_members/projects_members/index.md +++ b/docs/vercel-docs/providers/vercel/project_members/projects_members/index.md @@ -14,30 +14,33 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprojects_members
TypeResource
Idvercel.project_members.projects_members
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of this user. | -| `avatar` | `string` | ID of the file for the Avatar of this member. | -| `createdAt` | `number` | Timestamp in milliseconds when this member was added. | -| `email` | `string` | The email of this member. | -| `role` | `string` | Role of this user in the project. | -| `uid` | `string` | The ID of this user. | -| `username` | `string` | The unique username of this user. | +| | `string` | The name of this user. | +| | `string` | ID of the file for the Avatar of this member. | +| | `number` | Timestamp in milliseconds when this member was added. | +| | `string` | The email of this member. | +| | `string` | Role of this user in the project. | +| | `string` | The ID of this user. | +| | `string` | The unique username of this user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_project_members` | `SELECT` | `idOrName, teamId` | Lists all members of a project. | -| `remove_project_member` | `DELETE` | `idOrName, teamId, uid` | Remove a member from a specific project | -| `_get_project_members` | `EXEC` | `idOrName, teamId` | Lists all members of a project. | -| `add_project_member` | `EXEC` | `idOrName, teamId, data__role` | Adds a new member to the project. | +| | `SELECT` | | Lists all members of a project. | +| | `DELETE` | | Remove a member from a specific project | +| | `EXEC` | | Lists all members of a project. | +| | `EXEC` | | Adds a new member to the project. | diff --git a/docs/vercel-docs/providers/vercel/projects/domains/index.md b/docs/vercel-docs/providers/vercel/projects/domains/index.md index 188d8b04ec..87f1c151ff 100644 --- a/docs/vercel-docs/providers/vercel/projects/domains/index.md +++ b/docs/vercel-docs/providers/vercel/projects/domains/index.md @@ -14,36 +14,39 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedomains
TypeResource
Idvercel.projects.domains
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | | -| `apexName` | `string` | | -| `createdAt` | `number` | | -| `gitBranch` | `string` | | -| `projectId` | `string` | | -| `redirect` | `string` | | -| `redirectStatusCode` | `number` | | -| `updatedAt` | `number` | | -| `verification` | `array` | A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. | -| `verified` | `boolean` | `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. | +| | `string` | | +| | `string` | | +| | `number` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `number` | | +| | `number` | | +| | `array` | A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. | +| | `boolean` | `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_project_domain` | `SELECT` | `domain, idOrName, teamId` | Get project domain by project id/name and domain name. | -| `get_project_domains` | `SELECT` | `idOrName, teamId` | Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. | -| `remove_project_domain` | `DELETE` | `domain, idOrName, teamId` | Remove a domain from a project by passing the domain name and by specifying the project by either passing the project `id` or `name` in the URL. | -| `_get_project_domains` | `EXEC` | `idOrName, teamId` | Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. | -| `add_project_domain` | `EXEC` | `idOrName, teamId, data__name` | Add a domain to the project by passing its domain name and by specifying the project by either passing the project `id` or `name` in the URL. If the domain is not yet verified to be used on this project, the request will return `verified = false`, and the domain will need to be verified according to the `verification` challenge via `POST /projects/:idOrName/domains/:domain/verify`. If the domain already exists on the project, the request will fail with a `400` status code. | -| `update_project_domain` | `EXEC` | `domain, idOrName, teamId` | Update a project domain's configuration, including the name, git branch and redirect of the domain. | -| `verify_project_domain` | `EXEC` | `domain, idOrName, teamId` | Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge. | +| | `SELECT` | | Get project domain by project id/name and domain name. | +| | `SELECT` | | Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. | +| | `DELETE` | | Remove a domain from a project by passing the domain name and by specifying the project by either passing the project `id` or `name` in the URL. | +| | `EXEC` | | Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. | +| | `EXEC` | | Add a domain to the project by passing its domain name and by specifying the project by either passing the project `id` or `name` in the URL. If the domain is not yet verified to be used on this project, the request will return `verified = false`, and the domain will need to be verified according to the `verification` challenge via `POST /projects/:idOrName/domains/:domain/verify`. If the domain already exists on the project, the request will fail with a `400` status code. | +| | `EXEC` | | Update a project domain's configuration, including the name, git branch and redirect of the domain. | +| | `EXEC` | | Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge. | diff --git a/docs/vercel-docs/providers/vercel/projects/env/index.md b/docs/vercel-docs/providers/vercel/projects/env/index.md index f1b5dde6c7..7632cbf796 100644 --- a/docs/vercel-docs/providers/vercel/projects/env/index.md +++ b/docs/vercel-docs/providers/vercel/projects/env/index.md @@ -14,39 +14,42 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameenv
TypeResource
Idvercel.projects.env
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | | -| `configurationId` | `string` | | -| `contentHint` | `` | | -| `createdAt` | `number` | | -| `createdBy` | `string` | | -| `decrypted` | `boolean` | Whether `value` is decrypted. | -| `edgeConfigId` | `string` | | -| `edgeConfigTokenId` | `string` | | -| `gitBranch` | `string` | | -| `key` | `string` | | -| `target` | `` | | -| `type` | `string` | | -| `updatedAt` | `number` | | -| `updatedBy` | `string` | | -| `value` | `string` | | +| | `string` | | +| | `string` | | +| | `` | | +| | `number` | | +| | `string` | | +| | `boolean` | Whether `value` is decrypted. | +| | `string` | | +| | `string` | | +| | `string` | | +| | `string` | | +| | `` | | +| | `string` | | +| | `number` | | +| | `string` | | +| | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_project_env` | `SELECT` | `id, idOrName, teamId` | Retrieve the environment variable for a given project. | -| `create_project_env` | `INSERT` | `idOrName, teamId` | Create one ore more environment variables for a project by passing its `key`, `value`, `type` and `target` and by specifying the project by either passing the project `id` or `name` in the URL. | -| `remove_project_env` | `DELETE` | `id, idOrName, teamId` | Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. | -| `edit_project_env` | `EXEC` | `id, idOrName, teamId` | Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. | -| `filter_project_envs` | `EXEC` | `idOrName, teamId` | Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL. | +| | `SELECT` | | Retrieve the environment variable for a given project. | +| | `INSERT` | | Create one ore more environment variables for a project by passing its `key`, `value`, `type` and `target` and by specifying the project by either passing the project `id` or `name` in the URL. | +| | `DELETE` | | Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. | +| | `EXEC` | | Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. | +| | `EXEC` | | Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL. | diff --git a/docs/vercel-docs/providers/vercel/projects/index.md b/docs/vercel-docs/providers/vercel/projects/index.md index 0bb5f89ee6..f0f6d625a6 100644 --- a/docs/vercel-docs/providers/vercel/projects/index.md +++ b/docs/vercel-docs/providers/vercel/projects/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Projects :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/projects/projects/index.md b/docs/vercel-docs/providers/vercel/projects/projects/index.md index de3598ce91..13914228f6 100644 --- a/docs/vercel-docs/providers/vercel/projects/projects/index.md +++ b/docs/vercel-docs/providers/vercel/projects/projects/index.md @@ -14,77 +14,80 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprojects
TypeResource
Idvercel.projects.projects
Id
## Fields | Name | Datatype | |:-----|:---------| -| `id` | `string` | -| `name` | `string` | -| `accountId` | `string` | -| `analytics` | `object` | -| `autoAssignCustomDomains` | `boolean` | -| `autoAssignCustomDomainsUpdatedBy` | `string` | -| `autoExposeSystemEnvs` | `boolean` | -| `buildCommand` | `string` | -| `commandForIgnoringBuildStep` | `string` | -| `connectBuildsEnabled` | `boolean` | -| `connectConfigurationId` | `string` | -| `createdAt` | `number` | -| `crons` | `object` | -| `customerSupportCodeVisibility` | `boolean` | -| `dataCache` | `object` | -| `devCommand` | `string` | -| `directoryListing` | `boolean` | -| `enablePreviewFeedback` | `boolean` | -| `env` | `array` | -| `framework` | `string` | -| `gitComments` | `object` | -| `gitForkProtection` | `boolean` | -| `gitLFS` | `boolean` | -| `hasActiveBranches` | `boolean` | -| `hasFloatingAliases` | `boolean` | -| `installCommand` | `string` | -| `lastAliasRequest` | `object` | -| `lastRollbackTarget` | `object` | -| `latestDeployments` | `array` | -| `link` | `` | -| `live` | `boolean` | -| `nodeVersion` | `string` | -| `outputDirectory` | `string` | -| `passwordProtection` | `object` | -| `paused` | `boolean` | -| `permissions` | `object` | -| `productionDeploymentsFastLane` | `boolean` | -| `protectionBypass` | `object` | -| `publicSource` | `boolean` | -| `rootDirectory` | `string` | -| `serverlessFunctionRegion` | `string` | -| `skipGitConnectDuringLink` | `boolean` | -| `sourceFilesOutsideRootDirectory` | `boolean` | -| `ssoProtection` | `object` | -| `targets` | `object` | -| `transferCompletedAt` | `number` | -| `transferStartedAt` | `number` | -| `transferToAccountId` | `string` | -| `transferredFromAccountId` | `string` | -| `trustedIps` | `` | -| `updatedAt` | `number` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `number` | +| | `object` | +| | `boolean` | +| | `object` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `array` | +| | `string` | +| | `object` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `string` | +| | `object` | +| | `object` | +| | `array` | +| || +| | `boolean` | +| | `string` | +| | `string` | +| | `object` | +| | `boolean` | +| | `object` | +| | `boolean` | +| | `object` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `object` | +| | `object` | +| | `number` | +| | `number` | +| | `string` | +| | `string` | +| || +| | `number` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_project` | `SELECT` | `idOrName, teamId` | Get the information for a specific project by passing either the project `id` or `name` in the URL. | -| `get_projects` | `SELECT` | `teamId` | Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects. | -| `create_project` | `INSERT` | `teamId, data__name` | Allows to create a new project with the provided configuration. It only requires the project `name` but more configuration can be provided to override the defaults. | -| `delete_project` | `DELETE` | `idOrName, teamId` | Delete a specific project by passing either the project `id` or `name` in the URL. | -| `_get_projects` | `EXEC` | `teamId` | Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects. | -| `update_project` | `EXEC` | `idOrName, teamId` | Update the fields of a project using either its `name` or `id`. | -| `update_project_data_cache` | `EXEC` | `projectId, teamId` | Update the data cache feature on a project. | +| | `SELECT` | | Get the information for a specific project by passing either the project `id` or `name` in the URL. | +| | `SELECT` | | Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects. | +| | `INSERT` | | Allows to create a new project with the provided configuration. It only requires the project `name` but more configuration can be provided to override the defaults. | +| | `DELETE` | | Delete a specific project by passing either the project `id` or `name` in the URL. | +| | `EXEC` | | Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects. | +| | `EXEC` | | Update the fields of a project using either its `name` or `id`. | +| | `EXEC` | | Update the data cache feature on a project. | diff --git a/docs/vercel-docs/providers/vercel/secrets/index.md b/docs/vercel-docs/providers/vercel/secrets/index.md index 6a0e5698d5..9988cf5060 100644 --- a/docs/vercel-docs/providers/vercel/secrets/index.md +++ b/docs/vercel-docs/providers/vercel/secrets/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Secrets :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/secrets/secrets/index.md b/docs/vercel-docs/providers/vercel/secrets/secrets/index.md index c9b55f51dc..f4ea67dd24 100644 --- a/docs/vercel-docs/providers/vercel/secrets/secrets/index.md +++ b/docs/vercel-docs/providers/vercel/secrets/secrets/index.md @@ -14,34 +14,37 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesecrets
TypeResource
Idvercel.secrets.secrets
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of the secret. | -| `created` | `string` | The date when the secret was created. | -| `createdAt` | `number` | Timestamp for when the secret was created. | -| `decryptable` | `boolean` | Indicates whether the secret value can be decrypted after it has been created. | -| `projectId` | `string` | The unique identifier of the project which the secret belongs to. | -| `teamId` | `string` | The unique identifier of the team the secret was created for. | -| `uid` | `string` | The unique identifier of the secret. | -| `userId` | `string` | The unique identifier of the user who created the secret. | -| `value` | `string` | The value of the secret. | +| | `string` | The name of the secret. | +| | `string` | The date when the secret was created. | +| | `number` | Timestamp for when the secret was created. | +| | `boolean` | Indicates whether the secret value can be decrypted after it has been created. | +| | `string` | The unique identifier of the project which the secret belongs to. | +| | `string` | The unique identifier of the team the secret was created for. | +| | `string` | The unique identifier of the secret. | +| | `string` | The unique identifier of the user who created the secret. | +| | `string` | The value of the secret. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_secret` | `SELECT` | `idOrName, teamId` | Retrieves the information for a specific secret by passing either the secret id or name in the URL. | -| `get_secrets` | `SELECT` | `teamId` | Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret. | -| `create_secret` | `INSERT` | `name, teamId, data__name, data__value` | Allows to create a new secret. | -| `delete_secret` | `DELETE` | `idOrName, teamId` | This deletes the user or team’s secret defined in the URL. | -| `_get_secrets` | `EXEC` | `teamId` | Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret. | -| `rename_secret` | `EXEC` | `name, teamId, data__name` | Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets. | +| | `SELECT` | | Retrieves the information for a specific secret by passing either the secret id or name in the URL. | +| | `SELECT` | | Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret. | +| | `INSERT` | | Allows to create a new secret. | +| | `DELETE` | | This deletes the user or team’s secret defined in the URL. | +| | `EXEC` | | Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret. | +| | `EXEC` | | Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets. | diff --git a/docs/vercel-docs/providers/vercel/teams/index.md b/docs/vercel-docs/providers/vercel/teams/index.md index 695a9b3e7b..24bc41da42 100644 --- a/docs/vercel-docs/providers/vercel/teams/index.md +++ b/docs/vercel-docs/providers/vercel/teams/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Teams :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/teams/invites/index.md b/docs/vercel-docs/providers/vercel/teams/invites/index.md index 8de1d82718..e36c80b07c 100644 --- a/docs/vercel-docs/providers/vercel/teams/invites/index.md +++ b/docs/vercel-docs/providers/vercel/teams/invites/index.md @@ -14,14 +14,17 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvites
TypeResource
Idvercel.teams.invites
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/vercel/stackql-vercel-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `delete_team_invite_code` | `DELETE` | `inviteId, teamId` | +| | `DELETE` | | diff --git a/docs/vercel-docs/providers/vercel/teams/members/index.md b/docs/vercel-docs/providers/vercel/teams/members/index.md index 95b7ba64f6..53bf617523 100644 --- a/docs/vercel-docs/providers/vercel/teams/members/index.md +++ b/docs/vercel-docs/providers/vercel/teams/members/index.md @@ -14,38 +14,41 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemembers
TypeResource
Idvercel.teams.members
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The name of this user. | -| `accessRequestedAt` | `number` | Timestamp in milliseconds for when this team member was accepted by an owner. | -| `avatar` | `string` | ID of the file for the Avatar of this member. | -| `bitbucket` | `object` | Information about the Bitbucket account of this user. | -| `confirmed` | `boolean` | Boolean that indicates if this member was confirmed by an owner. | -| `createdAt` | `number` | Timestamp in milliseconds when this member was added. | -| `email` | `string` | The email of this member. | -| `github` | `object` | Information about the GitHub account for this user. | -| `gitlab` | `object` | Information about the GitLab account of this user. | -| `joinedFrom` | `object` | Map with information about the members origin if they joined by requesting access. | -| `projects` | `array` | Array of project memberships | -| `role` | `string` | Role of this user in the team. | -| `uid` | `string` | The ID of this user. | -| `username` | `string` | The unique username of this user. | +| | `string` | The name of this user. | +| | `number` | Timestamp in milliseconds for when this team member was accepted by an owner. | +| | `string` | ID of the file for the Avatar of this member. | +| | `object` | Information about the Bitbucket account of this user. | +| | `boolean` | Boolean that indicates if this member was confirmed by an owner. | +| | `number` | Timestamp in milliseconds when this member was added. | +| | `string` | The email of this member. | +| | `object` | Information about the GitHub account for this user. | +| | `object` | Information about the GitLab account of this user. | +| | `object` | Map with information about the members origin if they joined by requesting access. | +| | `array` | Array of project memberships | +| | `string` | Role of this user in the team. | +| | `string` | The ID of this user. | +| | `string` | The unique username of this user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_members` | `SELECT` | `teamId` | Get a paginated list of team members for the provided team. | -| `remove_team_member` | `DELETE` | `teamId, uid` | Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. | -| `_get_team_members` | `EXEC` | `teamId` | Get a paginated list of team members for the provided team. | -| `invite_user_to_team` | `EXEC` | `teamId` | Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority. | -| `update_team_member` | `EXEC` | `teamId, uid` | Update the membership of a Team Member on the Team specified by `teamId`, such as changing the _role_ of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an `OWNER` of the Team. | +| | `SELECT` | | Get a paginated list of team members for the provided team. | +| | `DELETE` | | Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. | +| | `EXEC` | | Get a paginated list of team members for the provided team. | +| | `EXEC` | | Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority. | +| | `EXEC` | | Update the membership of a Team Member on the Team specified by `teamId`, such as changing the _role_ of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an `OWNER` of the Team. | diff --git a/docs/vercel-docs/providers/vercel/teams/request/index.md b/docs/vercel-docs/providers/vercel/teams/request/index.md index 8bcee10dcc..47656bcb94 100644 --- a/docs/vercel-docs/providers/vercel/teams/request/index.md +++ b/docs/vercel-docs/providers/vercel/teams/request/index.md @@ -14,29 +14,32 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerequest
TypeResource
Idvercel.teams.request
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `accessRequestedAt` | `number` | Timestamp in milliseconds when the user requested access to the team. | -| `bitbucket` | `object` | Map of the connected Bitbucket account. | -| `confirmed` | `boolean` | Current status of the membership. Will be `true` if confirmed, if pending it'll be `false`. | -| `github` | `object` | Map of the connected GitHub account. | -| `gitlab` | `object` | Map of the connected GitLab account. | -| `joinedFrom` | `object` | A map that describes the origin from where the user joined. | -| `teamName` | `string` | The name of the team. | -| `teamSlug` | `string` | The slug of the team. | +| | `number` | Timestamp in milliseconds when the user requested access to the team. | +| | `object` | Map of the connected Bitbucket account. | +| | `boolean` | Current status of the membership. Will be `true` if confirmed, if pending it'll be `false`. | +| | `object` | Map of the connected GitHub account. | +| | `object` | Map of the connected GitLab account. | +| | `object` | A map that describes the origin from where the user joined. | +| | `string` | The name of the team. | +| | `string` | The slug of the team. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_access_request` | `SELECT` | `teamId, userId` | Check the status of a join request. It'll respond with a 404 if the request has been declined. If no `userId` path segment was provided, this endpoint will instead return the status of the authenticated user. | -| `request_access_to_team` | `EXEC` | `teamId, data__joinedFrom` | Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time. | +| | `SELECT` | | Check the status of a join request. It'll respond with a 404 if the request has been declined. If no `userId` path segment was provided, this endpoint will instead return the status of the authenticated user. | +| | `EXEC` | | Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time. | diff --git a/docs/vercel-docs/providers/vercel/teams/teams/index.md b/docs/vercel-docs/providers/vercel/teams/teams/index.md index 33b60ea71e..a3fd2b7d60 100644 --- a/docs/vercel-docs/providers/vercel/teams/teams/index.md +++ b/docs/vercel-docs/providers/vercel/teams/teams/index.md @@ -14,30 +14,33 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteams
TypeResource
Idvercel.teams.teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The Team's unique identifier. | -| `name` | `string` | Name associated with the Team account, or `null` if none has been provided. | -| `avatar` | `string` | The ID of the file used as avatar for this Team. | -| `slug` | `string` | The Team's slug, which is unique across the Vercel platform. | +| | `string` | The Team's unique identifier. | +| | `string` | Name associated with the Team account, or `null` if none has been provided. | +| | `string` | The ID of the file used as avatar for this Team. | +| | `string` | The Team's slug, which is unique across the Vercel platform. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team` | `SELECT` | `teamId` | Get information for the Team specified by the `teamId` parameter. | -| `get_teams` | `SELECT` | | Get a paginated list of all the Teams the authenticated User is a member of. | -| `create_team` | `INSERT` | `data__slug` | Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name. | -| `delete_team` | `DELETE` | `teamId` | Delete a team under your account. You need to send a `DELETE` request with the desired team `id`. An optional array of reasons for deletion may also be sent. | -| `_get_teams` | `EXEC` | | Get a paginated list of all the Teams the authenticated User is a member of. | -| `join_team` | `EXEC` | `teamId` | Join a team with a provided invite code or team ID. | -| `patch_team` | `EXEC` | `teamId` | Update the information of a Team specified by the `teamId` parameter. The request body should contain the information that will be updated on the Team. | +| | `SELECT` | | Get information for the Team specified by the `teamId` parameter. | +| | `SELECT` | | Get a paginated list of all the Teams the authenticated User is a member of. | +| | `INSERT` | | Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name. | +| | `DELETE` | | Delete a team under your account. You need to send a `DELETE` request with the desired team `id`. An optional array of reasons for deletion may also be sent. | +| | `EXEC` | | Get a paginated list of all the Teams the authenticated User is a member of. | +| | `EXEC` | | Join a team with a provided invite code or team ID. | +| | `EXEC` | | Update the information of a Team specified by the `teamId` parameter. The request body should contain the information that will be updated on the Team. | diff --git a/docs/vercel-docs/providers/vercel/user/events/index.md b/docs/vercel-docs/providers/vercel/user/events/index.md index 58a593c3e0..fee3945873 100644 --- a/docs/vercel-docs/providers/vercel/user/events/index.md +++ b/docs/vercel-docs/providers/vercel/user/events/index.md @@ -14,27 +14,30 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevents
TypeResource
Idvercel.user.events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the Event. | -| `createdAt` | `number` | Timestamp (in milliseconds) of when the event was generated. | -| `entities` | `array` | A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links. | -| `text` | `string` | The human-readable text of the Event. | -| `user` | `object` | Metadata for the User who generated the event. | -| `userId` | `string` | The unique identifier of the User who generated the event. | +| | `string` | The unique identifier of the Event. | +| | `number` | Timestamp (in milliseconds) of when the event was generated. | +| | `array` | A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links. | +| | `string` | The human-readable text of the Event. | +| | `object` | Metadata for the User who generated the event. | +| | `string` | The unique identifier of the User who generated the event. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_user_events` | `SELECT` | `teamId` | -| `_list_user_events` | `EXEC` | `teamId` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/vercel-docs/providers/vercel/user/index.md b/docs/vercel-docs/providers/vercel/user/index.md index 5483a03ead..c8ff8ee491 100644 --- a/docs/vercel-docs/providers/vercel/user/index.md +++ b/docs/vercel-docs/providers/vercel/user/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + User :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/user/user/index.md b/docs/vercel-docs/providers/vercel/user/user/index.md index f9a292cafb..64da78c199 100644 --- a/docs/vercel-docs/providers/vercel/user/user/index.md +++ b/docs/vercel-docs/providers/vercel/user/user/index.md @@ -14,52 +14,55 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser
TypeResource
Idvercel.user.user
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The User's unique identifier. | -| `name` | `string` | Name associated with the User account, or `null` if none has been provided. | -| `AuthUserLimited_avatar` | `string` | SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. | -| `AuthUserLimited_email` | `string` | Email address associated with the User account. | -| `AuthUserLimited_id` | `string` | The User's unique identifier. | -| `AuthUserLimited_name` | `string` | Name associated with the User account, or `null` if none has been provided. | -| `AuthUserLimited_username` | `string` | Unique username associated with the User account. | -| `AuthUserLimited_version` | `string` | The user's version. Will either be unset or `northstar`. | -| `activeDashboardViews` | `array` | set of dashboard view preferences (cards or list) per scopeId | -| `avatar` | `string` | SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. | -| `billing` | `object` | An object containing billing infomation associated with the User account. | -| `createdAt` | `number` | UNIX timestamp (in milliseconds) when the User account was created. | -| `dataCache` | `object` | data cache settings | -| `defaultTeamId` | `string` | The user's default team. Only applies if the user's `version` is `'northstar'`. | -| `dismissedToasts` | `array` | A record of when, under a certain scopeId, a toast was dismissed | -| `email` | `string` | Email address associated with the User account. | -| `favoriteProjectsAndSpaces` | `array` | A list of projects and spaces across teams that a user has marked as a favorite. | -| `featureBlocks` | `object` | Feature blocks for the user | -| `hasTrialAvailable` | `boolean` | Whether the user has a trial available for a paid plan subscription. | -| `importFlowGitNamespace` | `` | | -| `importFlowGitNamespaceId` | `` | | -| `importFlowGitProvider` | `string` | | -| `limited` | `boolean` | Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges. | -| `preferredScopesAndGitNamespaces` | `array` | | -| `remoteCaching` | `object` | remote caching settings | -| `resourceConfig` | `object` | An object containing infomation related to the amount of platform resources may be allocated to the User account. | -| `softBlock` | `object` | When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why. | -| `stagingPrefix` | `string` | Prefix that will be used in the URL of "Preview" deployments created by the User account. | -| `username` | `string` | Unique username associated with the User account. | -| `version` | `string` | The user's version. Will either be unset or `northstar`. | +| | `string` | The User's unique identifier. | +| | `string` | Name associated with the User account, or `null` if none has been provided. | +| | `string` | SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. | +| | `string` | Email address associated with the User account. | +| | `string` | The User's unique identifier. | +| | `string` | Name associated with the User account, or `null` if none has been provided. | +| | `string` | Unique username associated with the User account. | +| | `string` | The user's version. Will either be unset or `northstar`. | +| | `array` | set of dashboard view preferences (cards or list) per scopeId | +| | `string` | SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. | +| | `object` | An object containing billing infomation associated with the User account. | +| | `number` | UNIX timestamp (in milliseconds) when the User account was created. | +| | `object` | data cache settings | +| | `string` | The user's default team. Only applies if the user's `version` is `'northstar'`. | +| | `array` | A record of when, under a certain scopeId, a toast was dismissed | +| | `string` | Email address associated with the User account. | +| | `array` | A list of projects and spaces across teams that a user has marked as a favorite. | +| | `object` | Feature blocks for the user | +| | `boolean` | Whether the user has a trial available for a paid plan subscription. | +| | `` | | +| | `` | | +| | `string` | | +| | `boolean` | Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges. | +| | `array` | | +| | `object` | remote caching settings | +| | `object` | An object containing infomation related to the amount of platform resources may be allocated to the User account. | +| | `object` | When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why. | +| | `string` | Prefix that will be used in the URL of "Preview" deployments created by the User account. | +| | `string` | Unique username associated with the User account. | +| | `string` | The user's version. Will either be unset or `northstar`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_auth_user` | `SELECT` | | Retrieves information related to the currently authenticated User. | -| `request_delete` | `DELETE` | | Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process. | -| `_get_auth_user` | `EXEC` | | Retrieves information related to the currently authenticated User. | +| | `SELECT` | | Retrieves information related to the currently authenticated User. | +| | `DELETE` | | Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process. | +| | `EXEC` | | Retrieves information related to the currently authenticated User. | diff --git a/docs/vercel-docs/providers/vercel/webhooks/index.md b/docs/vercel-docs/providers/vercel/webhooks/index.md index 04132f36d7..208352897b 100644 --- a/docs/vercel-docs/providers/vercel/webhooks/index.md +++ b/docs/vercel-docs/providers/vercel/webhooks/index.md @@ -13,6 +13,7 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- + Webhooks :::info Service Summary diff --git a/docs/vercel-docs/providers/vercel/webhooks/webhooks/index.md b/docs/vercel-docs/providers/vercel/webhooks/webhooks/index.md index 84e4553825..6bee039ca2 100644 --- a/docs/vercel-docs/providers/vercel/webhooks/webhooks/index.md +++ b/docs/vercel-docs/providers/vercel/webhooks/webhooks/index.md @@ -14,30 +14,33 @@ description: Query, deploy, and manage Vercel resources using SQL custom_edit_url: null image: /img/providers/vercel/stackql-vercel-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namewebhooks
TypeResource
Idvercel.webhooks.webhooks
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The webhook id | -| `createdAt` | `number` | A number containing the date when the webhook was created in in milliseconds | -| `events` | `array` | The webhooks events | -| `ownerId` | `string` | The unique ID of the team the webhook belongs to | -| `projectIds` | `array` | The ID of the projects the webhook is associated with | -| `updatedAt` | `number` | A number containing the date when the webhook was updated in in milliseconds | -| `url` | `string` | A string with the URL of the webhook | +| | `string` | The webhook id | +| | `number` | A number containing the date when the webhook was created in in milliseconds | +| | `array` | The webhooks events | +| | `string` | The unique ID of the team the webhook belongs to | +| | `array` | The ID of the projects the webhook is associated with | +| | `number` | A number containing the date when the webhook was updated in in milliseconds | +| | `string` | A string with the URL of the webhook | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_webhook` | `SELECT` | `id, teamId` | Get a webhook | -| `get_webhooks` | `SELECT` | `teamId` | Get a list of webhooks | -| `create_webhook` | `INSERT` | `teamId, data__events, data__url` | Creates a webhook | -| `delete_webhook` | `DELETE` | `id, teamId` | Deletes a webhook | +| | `SELECT` | | Get a webhook | +| | `SELECT` | | Get a list of webhooks | +| | `INSERT` | | Creates a webhook | +| | `DELETE` | | Deletes a webhook | diff --git a/scripts/docgen/functions.py b/scripts/docgen/functions.py index b8615373a1..80d774b1c7 100644 --- a/scripts/docgen/functions.py +++ b/scripts/docgen/functions.py @@ -287,7 +287,7 @@ def generate_methods_table(methods): output = output + '| | `%s` | | %s |\n' % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"], make_markdown_table_safe(methodRow["description"])) return output except: - output = output + "No methods available for the resource\n" + output = output + "No additional methods available for this resource\n" return output diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 0d840d0620..850d2026cd 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -363,7 +363,7 @@ 'vercel': { 'custom': False, 'variables': """ -- `VERCEL_API_TOKEN` - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) +- - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens)) """, 'linux': """ AUTH='{ "okta": { "type": "bearer", "credentialsenvvar": "YOUR_VERCEL_API_TOKEN_VAR" }}' @@ -380,7 +380,7 @@ 'godaddy': { 'custom': False, 'variables': """ -- `GODADDY_API_KEY` - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) +- - Godaddy API key (see [Creating a Godaddy API Key](https://developer.godaddy.com/keys)) """, 'linux': """ AUTH='{ "okta": { "type": "bearer", "credentialsenvvar": "YOUR_GODADDY_API_KEY_VAR" }}' @@ -397,7 +397,7 @@ 'pagerduty': { 'custom': False, 'variables': """ -- `PAGERDUTY_API_TOKEN` - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) +- - PagerDuty API token (see [Creating a PagerDuty API Token](https://support.pagerduty.com/docs/api-access-keys#section-generating-a-general-access-rest-api-key)) """, 'linux': """ AUTH='{ "pagerduty": { "type": "bearer", "credentialsenvvar": "YOUR_PAGERDUTY_API_TOKEN_VAR" }}'