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.
openapi: 3.2.0
info:
title: Pushcut Automation Server API
version: v1
contact:
name: Pushcut
email: feedback@pushcut.io
url: https://www.pushcut.io
x-logo:
url: https://www.pushcut.io/assets/pushcut-icon.png
altText: Pushcut Logo
description: 'Operations tagged Automation Server across 2 of this provider''s published API definitions: api-pushcut-openapi.yaml, pushcut-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.pushcut.io/v1
security:
- api_key: []
tags:
- description: For executing Automation Server actions
name: Automation Server
paths:
/execute:
post:
description: Schedules an Automation Server action request. Specify either a shortcut name or a HomeKit scene.
operationId: Execute
summary: Execute an Automation Server action
tags:
- Automation Server
x-ms-visibility: important
parameters:
- description: Shortcut
in: query
name: shortcut
required: false
example: My Shortcut
schema:
type: string
- description: HomeKit scene
in: query
name: homekit
required: false
example: Downstairs Lights On
schema:
type: string
- description: Timeout in seconds, or 'nowait'
in: query
name: timeout
required: false
example: nowait
schema:
type: string
- description: 'Duration in which this request should be executed. Eg: 10s, 15m, 6h'
in: query
name: delay
required: false
example: 10s
schema:
type: string
- description: Only used for delayed requests. Use an identifier to overwrite or cancel a scheduled execution.
in: query
name: identifier
required: false
example: MyIdentifier
schema:
type: string
- name: input
in: query
description: Value that is passed as input to the shortcut.
schema:
type: string
- name: serverId
in: query
description: The ID or name of the Automation Server that should execute the action.
schema:
type: string
requestBody:
description: Pass an input or optional configuration with the request.
content:
application/json:
schema:
oneOf:
- $ref: components/schemas/servers.yaml#/ExecuteShortcut
- $ref: components/schemas/servers.yaml#/ExecuteHomeKit
responses:
'200':
description: Success
'202':
description: Accepted (when scheduled with 'nowait')
'400':
$ref: definitions.yaml#/components/responses/400
'401':
$ref: definitions.yaml#/components/responses/401
'404':
$ref: definitions.yaml#/components/responses/404
'502':
$ref: definitions.yaml#/components/responses/502
'504':
$ref: definitions.yaml#/components/responses/504
servers:
- url: https://api.pushcut.io/v1
/cancelExecution:
post:
description: Cancels an Automation Server requests that was scheduled for future execution.
operationId: CancelExecution
summary: Cancel a scheduled Automation Server action
tags:
- Automation Server
x-ms-visibility: important
parameters:
- description: Identifier of the request.
in: query
name: identifier
required: false
example: MyIdentifier
schema:
type: string
responses:
'200':
description: Success
'400':
$ref: definitions.yaml#/components/responses/400
'401':
$ref: definitions.yaml#/components/responses/401
servers:
- url: https://api.pushcut.io/v1
components:
securitySchemes:
api_key:
description: API-Keys can be managed in the Account view of the Pushcut app.
in: header
name: API-Key
type: apiKey
externalDocs:
description: Pushcut Help Page
url: https://www.pushcut.io/help
x-refined-from:
- api-pushcut-openapi.yaml
- pushcut-openapi.yaml
x-ms-capabilities:
testConnection:
operationId: GetDevices
parameters: {}