Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ably rules API

The rules API from Ably — 2 operation(s) for rules.

Ably rules API is one of 12 APIs that Ably publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 5 operations across 2 paths, and defines 53 schemas. It is described by OpenAPI 3.0.1, at version 1.0.32.

Requests are made against a single base URL, https://control.ably.net/v1.

5 operations 2 paths 53 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.32
Base URL
https://rest.ably.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ably rules API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth).

  • bearer_auth — Control API uses bearer authentication. You need to generate an access token for use with this API. More details can be found in the Ably docs .

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

rules 5
GET
/apps/{app_id}/rules
Lists rules
1 param → 200401404500504
POST
/apps/{app_id}/rules
Creates a rule
1 param body → 201400401404422500504
GET
/apps/{app_id}/rules/{rule_id}
Gets a rule using a rule ID
2 params → 200401404500504
PATCH
/apps/{app_id}/rules/{rule_id}
Updates a Rule
2 params body → 200400401404422500504
DELETE
/apps/{app_id}/rules/{rule_id}
Deletes a rule
2 params → 204401404500504

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are aws_lambda_rule_response (11 properties), amqp_rule_response (11 properties), http_rule_response (11 properties), kafka_rule_response (11 properties). Each schema is shown below with its type and property counts.

aws_lambda_rule_post
object
5 properties 4 required
aws_access_keys_response
object
2 properties
unsupported_rule_response
object
11 properties 4 required
cloudflare_worker_rule_post
object
5 properties 4 required
kafka_rule_response
object
11 properties 4 required
amqp_external_rule_response
object
11 properties 4 required
pulsar_rule_response
object
11 properties 4 required
amqp_rule_patch
object
5 properties 1 required
aws_assume_role
object
2 properties 1 required
rule_patch
pulsar_rule_patch
object
5 properties 1 required
amqp_external_rule_post
object
4 properties 4 required
ingress_postgres_outbox_rule_post
object
3 properties 2 required
aws_sqs_rule_response
object
11 properties 4 required
zapier_rule_patch
object
5 properties 1 required
cloudflare_worker_rule_patch
object
5 properties 1 required
zapier_rule_post
object
5 properties 4 required
http_rule_post
object
5 properties 4 required
rule_response
azure_function_rule_post
object
5 properties 4 required
azure_function_rule_patch
object
5 properties 1 required
aws_access_keys
object
3 properties 2 required
aws_kinesis_rule_patch
object
5 properties 1 required
amqp_external_rule_patch
object
5 properties 1 required
aws_kinesis_rule_response
object
11 properties 4 required
ifttt_rule_response
object
11 properties 4 required
zapier_rule_response
object
11 properties 4 required
rule_post
kafka_rule_post
object
5 properties 4 required
ingress_postgres_outbox_rule_patch
object
3 properties 2 required
aws_lambda_rule_patch
object
5 properties 1 required
cloudflare_worker_rule_response
object
11 properties 4 required
aws_sqs_rule_post
object
5 properties 4 required
aws_kinesis_rule_post
object
5 properties 4 required
rule_source_patch
object
2 properties
ifttt_rule_post
object
5 properties 4 required
error
object
5 properties 4 required
aws_lambda_rule_response
object
11 properties 4 required
amqp_rule_response
object
11 properties 4 required
ifttt_rule_patch
object
5 properties 1 required
rule_source
object
2 properties 2 required
amqp_rule_post
object
5 properties 4 required
ingress_postgres_outbox_rule_response
object
9 properties 2 required
pulsar_rule_post
object
5 properties 4 required
google_cloud_function_rule_post
object
4 properties 4 required
http_rule_response
object
11 properties 4 required
google_cloud_function_rule_patch
object
5 properties 1 required
http_rule_patch
object
5 properties 1 required
google_cloud_function_rule_response
object
11 properties 4 required
pulsar_token_auth
object
2 properties 2 required
kafka_rule_patch
object
5 properties 1 required
aws_sqs_rule_patch
object
5 properties 1 required
azure_function_rule_response
object
11 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ably-rules-api-openapi.yml Raw ↑

Other APIs Ably publishes across the network.

Ably apps API
Ably Authentication API
Ably History API
Ably keys API
Ably namespaces API
Ably Publishing API
Ably Push API
Ably queues API
Ably Stats API
Ably Status API
Ably tokens API