All Quiet

All Quiet Service Resource API

The ServiceResource API from All Quiet — 2 operation(s) for serviceresource.

GitHub OpenAPI

Operations 4

GET /api/public/v1/service/{id} Get a service by ID #
PUT /api/public/v1/service/{id} Update a service #
DELETE /api/public/v1/service/{id} Delete a service #
POST /api/public/v1/service Create a service #

Documentation

📖
Documentation
https://docs.allquiet.app/essentials/incident
📖
APIReference
https://allquiet.app/api/public/swagger-ui/index.html
📖
Documentation
https://docs.allquiet.app/integrations/inbound/webhook
📖
Documentation
https://docs.allquiet.app/essentials/teams
📖
Documentation
https://docs.allquiet.app/essentials/escalations
📖
Documentation
https://docs.allquiet.app/essentials/outbound

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/allquiet/refs/heads/main/openapi/allquiet-serviceresource-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/allquiet/refs/heads/main/collections/allquiet.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/allquiet/refs/heads/main/collections/allquiet.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/allquiet:allquiet-serviceresource-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

allquiet-serviceresource-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: All Quiet Public Service Resource API
  version: v1
tags:
- name: ServiceResource
paths:
  /api/public/v1/service/{id}:
    get:
      tags:
      - ServiceResource
      summary: Get a service by ID
      description: 'Returns a single service in the organization.


        **Required API key permissions**


        - **Scope:** `services:get`

        - **Accepted key types:** organization API key (org-wide), personal access token (org-wide)

        - **Access:** Operates on a single organization. Pass organizationId when your API key spans multiple organizations.

        - **Required organization role (user-linked keys only):** Member

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: organizationId
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: services
        permission: get
        scope: services:get
        accessModel: org-singleton
        allowedKeyTypes:
        - organization API key (org-wide)
        - personal access token (org-wide)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: Member
        requiredTeamRoleForUserKeys: null
        notes: null
      operationId: getApiPublicV1ServiceById
      x-operation-id-source: derived
    put:
      tags:
      - ServiceResource
      summary: Update a service
      description: 'Updates an existing service by ID.


        **Required API key permissions**


        - **Scope:** `services:update`

        - **Accepted key types:** organization API key (org-wide), personal access token (org-wide)

        - **Access:** Operates on a single organization. Pass organizationId when your API key spans multiple organizations.

        - **Required organization role (user-linked keys only):** Administrator

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: organizationId
        in: query
        schema:
          type: string
          format: uuid
      - name: provision
        in: query
        description: When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceUpdateRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: services
        permission: update
        scope: services:update
        accessModel: org-singleton
        allowedKeyTypes:
        - organization API key (org-wide)
        - personal access token (org-wide)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: Administrator
        requiredTeamRoleForUserKeys: null
        notes: null
      operationId: putApiPublicV1ServiceById
      x-operation-id-source: derived
    delete:
      tags:
      - ServiceResource
      summary: Delete a service
      description: 'Permanently deletes a service by ID.


        **Required API key permissions**


        - **Scope:** `services:delete`

        - **Accepted key types:** organization API key (org-wide), personal access token (org-wide)

        - **Access:** Operates on a single organization. Pass organizationId when your API key spans multiple organizations.

        - **Required organization role (user-linked keys only):** Administrator

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: organizationId
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: services
        permission: delete
        scope: services:delete
        accessModel: org-singleton
        allowedKeyTypes:
        - organization API key (org-wide)
        - personal access token (org-wide)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: Administrator
        requiredTeamRoleForUserKeys: null
        notes: null
      operationId: deleteApiPublicV1ServiceById
      x-operation-id-source: derived
  /api/public/v1/service:
    post:
      tags:
      - ServiceResource
      summary: Create a service
      description: 'Creates a new service in the organization.


        **Required API key permissions**


        - **Scope:** `services:create`

        - **Accepted key types:** organization API key (org-wide), personal access token (org-wide)

        - **Access:** Operates on a single organization. Pass organizationId when your API key spans multiple organizations.

        - **Required organization role (user-linked keys only):** Administrator

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: organizationId
        in: query
        schema:
          type: string
          format: uuid
      - name: provision
        in: query
        description: When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceCreateRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.Services.ServiceResourceResponse'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: services
        permission: create
        scope: services:create
        accessModel: org-singleton
        allowedKeyTypes:
        - organization API key (org-wide)
        - personal access token (org-wide)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: Administrator
        requiredTeamRoleForUserKeys: null
        notes: null
      operationId: postApiPublicV1Service
      x-operation-id-source: derived
components:
  schemas:
    AllQuiet.Api.StatusPages.Models.ServiceIntegration:
      type: object
      properties:
        id:
          type: string
          format: uuid
        integrationId:
          type: string
          format: uuid
        severities:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    AllQuiet.Api.Public.Services.ServiceResourceUpdateRequest:
      required:
      - displayName
      - publicTitle
      type: object
      properties:
        displayName:
          maxLength: 500
          minLength: 1
          type: string
        publicTitle:
          maxLength: 500
          minLength: 1
          type: string
        publicDescription:
          maxLength: 10000
          type:
          - string
          - 'null'
        templates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIncidentTemplate'
        integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIntegration'
        teamConnectionSettings:
          $ref: '#/components/schemas/AllQuiet.Api.Teams.Common.TeamConnectionSettings'
      additionalProperties: false
    AllQuiet.Api.Teams.Common.TeamConnectionSettings:
      type: object
      properties:
        teamConnectionMode:
          type:
          - string
          - 'null'
        teamIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
    AllQuiet.Api.Public.Services.ServiceResourceCreateRequest:
      required:
      - displayName
      - publicTitle
      type: object
      properties:
        displayName:
          maxLength: 500
          minLength: 1
          type: string
        publicTitle:
          maxLength: 500
          minLength: 1
          type: string
        publicDescription:
          maxLength: 10000
          type:
          - string
          - 'null'
        templates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIncidentTemplate'
        integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIntegration'
        teamConnectionSettings:
          $ref: '#/components/schemas/AllQuiet.Api.Teams.Common.TeamConnectionSettings'
      additionalProperties: false
    AllQuiet.Api.StatusPages.Models.ServiceIncidentTemplate:
      required:
      - displayName
      - message
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        displayName:
          minLength: 1
          type: string
        message:
          minLength: 1
          type: string
      additionalProperties: false
    AllQuiet.Api.Public.Services.ServiceResourceResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        isProvisioned:
          type: boolean
        displayName:
          type:
          - string
          - 'null'
        publicTitle:
          type:
          - string
          - 'null'
        publicDescription:
          type:
          - string
          - 'null'
        templates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIncidentTemplate'
        integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.StatusPages.Models.ServiceIntegration'
        teamConnectionSettings:
          $ref: '#/components/schemas/AllQuiet.Api.Teams.Common.TeamConnectionSettings'
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API key authentication. Pass the key as `Authorization: Bearer <key>` or `X-Api-Key: <key>`. Each operation documents required scopes and accepted key types.'
      name: Authorization
      in: header
x-provenance:
  method: harvested
  publisher: All Quiet
  source: https://allquiet.app/api/swagger/public-v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)