{ "openapi": "3.1.0", "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base", "info": { "title": "Streamnode API", "description": "https://api.streamnode.io API Reference", "version": "1.0.0" }, "servers": [ { "url": "https://api.streamnode.io" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key" } } }, "paths": { "/v1/projects": { "get": { "summary": "List projects", "description": "Returns a paginated list of projects.", "operationId": "api.endpoint.projects.list", "tags": [ "Projects" ], "x-required-scope": { "scope": "projects", "ability": "read" }, "parameters": [ { "name": "is", "in": "query", "required": false, "description": "The project You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/projects", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "prj_xRL9Jloy4gKXpnNj", "object": "project", "name": "my-project", "description": "Marketing links and campaigns", "is_default": false, "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a project", "description": "Creates and returns a project.", "operationId": "api.endpoint.projects.create", "tags": [ "Projects" ], "x-required-scope": { "scope": "projects", "ability": "write" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "prj_xRL9Jloy4gKXpnNj", "object": "project", "name": "my-project", "description": "Marketing links and campaigns", "is_default": false, "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/projects/{id}": { "get": { "summary": "Get a project", "description": "Returns the project with the given ID.", "operationId": "api.endpoint.projects.get", "tags": [ "Projects" ], "x-required-scope": { "scope": "projects", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "prj_xRL9Jloy4gKXpnNj", "object": "project", "name": "my-project", "description": "Marketing links and campaigns", "is_default": false, "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a project", "description": "Updates and returns the project with the given ID.", "operationId": "api.endpoint.projects.update", "tags": [ "Projects" ], "x-required-scope": { "scope": "projects", "ability": "write" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "prj_xRL9Jloy4gKXpnNj", "object": "project", "name": "my-project", "description": "Marketing links and campaigns", "is_default": false, "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a project", "description": "Deletes the project with the given ID.", "operationId": "api.endpoint.projects.delete", "tags": [ "Projects" ], "x-required-scope": { "scope": "projects", "ability": "delete" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "prj_xRL9Jloy4gKXpnNj", "object": "project", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/projects/{project}/folders": { "get": { "summary": "List project folders", "description": "Returns all folders for the given project ID.", "operationId": "api.endpoint.projects.folders.list", "tags": [ "Project folders" ], "x-required-scope": { "scope": "projects", "ability": "read" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "null" }, "name": { "type": "string" }, "slug": { "type": "string" }, "path": { "type": "string" }, "depth": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "example": [ { "id": "fld_v2P8jeN39GoYpQWO", "object": "project_folder", "project": "prj_xRL9Jloy4gKXpnNj", "parent": null, "name": "My lovely folder", "slug": "my-lovely-folder", "path": "marketing/my-lovely-folder", "depth": 1, "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } ] } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a project folder", "description": "Creates and returns a folder for the given project ID.", "operationId": "api.endpoint.projects.folders.create", "tags": [ "Project folders" ], "x-required-scope": { "scope": "projects", "ability": "write" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "null" }, "name": { "type": "string" }, "slug": { "type": "string" }, "path": { "type": "string" }, "depth": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "fld_v2P8jeN39GoYpQWO", "object": "project_folder", "project": "prj_xRL9Jloy4gKXpnNj", "parent": null, "name": "My lovely folder", "slug": "my-lovely-folder", "path": "marketing/my-lovely-folder", "depth": 1, "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/projects/{project}/folders/{id}": { "get": { "summary": "Get a project folder", "description": "Returns the folder with the given ID for the given project ID.", "operationId": "api.endpoint.projects.folders.get", "tags": [ "Project folders" ], "x-required-scope": { "scope": "projects", "ability": "read" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "null" }, "name": { "type": "string" }, "slug": { "type": "string" }, "path": { "type": "string" }, "depth": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "fld_v2P8jeN39GoYpQWO", "object": "project_folder", "project": "prj_xRL9Jloy4gKXpnNj", "parent": null, "name": "My lovely folder", "slug": "my-lovely-folder", "path": "marketing/my-lovely-folder", "depth": 1, "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a project folder", "description": "Updates and returns the folder with the given ID for the given project ID.", "operationId": "api.endpoint.projects.folders.update", "tags": [ "Project folders" ], "x-required-scope": { "scope": "projects", "ability": "write" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "null" }, "name": { "type": "string" }, "slug": { "type": "string" }, "path": { "type": "string" }, "depth": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "fld_v2P8jeN39GoYpQWO", "object": "project_folder", "project": "prj_xRL9Jloy4gKXpnNj", "parent": null, "name": "My lovely folder", "slug": "my-lovely-folder", "path": "marketing/my-lovely-folder", "depth": 1, "created_at": "2026-06-08T23:54:47+00:00", "updated_at": "2026-06-08T23:54:47+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a project folder", "description": "Deletes the folder with the given ID for the given project ID.", "operationId": "api.endpoint.projects.folders.delete", "tags": [ "Project folders" ], "x-required-scope": { "scope": "projects", "ability": "delete" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "fld_v2P8jeN39GoYpQWO", "object": "project_folder", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/domains": { "get": { "summary": "List domains", "description": "Returns a paginated list of domains.", "operationId": "api.endpoint.domains.list", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "read" }, "parameters": [ { "name": "is", "in": "query", "required": false, "description": "The domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "dns_status", "in": "query", "required": false, "description": "The DNS status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "validating", "valid", "invalid", "error" ] } }, { "name": "ssl_status", "in": "query", "required": false, "description": "The SSL certificate status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "provisioning", "active", "expired", "deactivated", "error" ] } }, { "name": "status", "in": "query", "required": false, "description": "The status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "provisioning", "active", "unverified", "error" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/domains", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a domain", "description": "Creates and returns a new custom domain. Streamnode managed domains cannot be created through this endpoint.", "operationId": "api.endpoint.domains.create", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "write" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/domains/{id}": { "get": { "summary": "Get a domain", "description": "Returns the domain with the given ID or domain name.", "operationId": "api.endpoint.domains.get", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a domain", "description": "Updates mutable fields for a Streamnode managed domain. Custom domains are read-only through this endpoint.", "operationId": "api.endpoint.domains.update", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "write" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a domain", "description": "Deletes a custom domain with the given ID or name. Streamnode managed domains cannot be deleted.", "operationId": "api.endpoint.domains.delete", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "delete" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/domains/{id}/verify-dns": { "post": { "summary": "Verify a domain", "description": "Triggers DNS verification for a custom domain and returns the updated domain state.", "operationId": "api.endpoint.domains.verify-dns", "tags": [ "Domains" ], "x-required-scope": { "scope": "domains", "ability": "write" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/urls": { "get": { "summary": "List URLs", "description": "Returns a paginated list of URLs.", "operationId": "api.endpoint.urls.list", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "read" }, "parameters": [ { "name": "domain:is", "in": "query", "required": false, "description": "The domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "domain:dns_status", "in": "query", "required": false, "description": "The DNS status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "validating", "valid", "invalid", "error" ] } }, { "name": "domain:ssl_status", "in": "query", "required": false, "description": "The SSL certificate status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "provisioning", "active", "expired", "deactivated", "error" ] } }, { "name": "domain:status", "in": "query", "required": false, "description": "The status of the domain You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "pending", "provisioning", "active", "unverified", "error" ] } }, { "name": "status", "in": "query", "required": false, "description": "The status of the url You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "enabled", "disabled", "expired", "archived" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "folder": { "type": "string" }, "status": { "type": "string" }, "method": { "type": "string" }, "domain": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "is_fallback": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "null" }, "metadata": { "type": "null" }, "expires_at": { "type": "string" }, "delete_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/urls", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "url_NyY9KBD3m5aEOqzb", "object": "url", "project": "prj_xRL9Jloy4gKXpnNj", "folder": "fld_v2P8jeN39GoYpQWO", "status": "enabled", "method": "GET", "domain": "link.example.com", "path": "google", "url": "https://link.example.com/google", "is_fallback": false, "name": "Google.com redirect", "description": "Redirects to google.com", "schema_template": null, "metadata": null, "expires_at": "2026-06-08T23:54:48+00:00", "delete_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a URL", "description": "Creates and returns a non-fallback URL. If `path` is omitted, a path is generated automatically.", "operationId": "api.endpoint.urls.create", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "write" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "folder": { "type": "string" }, "method": { "type": "string", "enum": [ "OPTIONS", "HEAD", "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "domain": { "type": "string" }, "path": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "object" }, "expires_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "error_on_duplicate": { "type": "boolean" } }, "required": [ "domain", "schema_template" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "folder": { "type": "string" }, "status": { "type": "string" }, "method": { "type": "string" }, "domain": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "is_fallback": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "null" }, "metadata": { "type": "null" }, "expires_at": { "type": "string" }, "delete_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "url_NyY9KBD3m5aEOqzb", "object": "url", "project": "prj_xRL9Jloy4gKXpnNj", "folder": "fld_v2P8jeN39GoYpQWO", "status": "enabled", "method": "GET", "domain": "link.example.com", "path": "google", "url": "https://link.example.com/google", "is_fallback": false, "name": "Google.com redirect", "description": "Redirects to google.com", "schema_template": null, "metadata": null, "expires_at": "2026-06-08T23:54:48+00:00", "delete_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/urls/{id}": { "get": { "summary": "Get a URL", "description": "Returns the URL with the given ID.", "operationId": "api.endpoint.urls.get", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "folder": { "type": "string" }, "status": { "type": "string" }, "method": { "type": "string" }, "domain": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "is_fallback": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "null" }, "metadata": { "type": "null" }, "expires_at": { "type": "string" }, "delete_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "url_NyY9KBD3m5aEOqzb", "object": "url", "project": "prj_xRL9Jloy4gKXpnNj", "folder": "fld_v2P8jeN39GoYpQWO", "status": "enabled", "method": "GET", "domain": "link.example.com", "path": "google", "url": "https://link.example.com/google", "is_fallback": false, "name": "Google.com redirect", "description": "Redirects to google.com", "schema_template": null, "metadata": null, "expires_at": "2026-06-08T23:54:48+00:00", "delete_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a URL", "description": "Updates and returns the URL with the given ID.", "operationId": "api.endpoint.urls.update", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "write" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "folder": { "type": "string" }, "method": { "type": "string", "enum": [ "OPTIONS", "HEAD", "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "domain": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "string", "enum": [ "enabled", "disabled", "expired", "archived" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "object" }, "expires_at": { "type": "string", "format": "date-time" }, "delete_at": { "type": "string", "format": "date-time" }, "error_on_duplicate": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "folder": { "type": "string" }, "status": { "type": "string" }, "method": { "type": "string" }, "domain": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "is_fallback": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schema_template": { "type": "null" }, "metadata": { "type": "null" }, "expires_at": { "type": "string" }, "delete_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "url_NyY9KBD3m5aEOqzb", "object": "url", "project": "prj_xRL9Jloy4gKXpnNj", "folder": "fld_v2P8jeN39GoYpQWO", "status": "enabled", "method": "GET", "domain": "link.example.com", "path": "google", "url": "https://link.example.com/google", "is_fallback": false, "name": "Google.com redirect", "description": "Redirects to google.com", "schema_template": null, "metadata": null, "expires_at": "2026-06-08T23:54:48+00:00", "delete_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a URL", "description": "Deletes the URL with the given ID.", "operationId": "api.endpoint.urls.delete", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "delete" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "url_NyY9KBD3m5aEOqzb", "object": "url", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/urls/validate-schema": { "post": { "summary": "Validate a URL schema", "description": "Validates a URL schema template and returns validation details.", "operationId": "api.endpoint.urls.validate-schema", "tags": [ "Urls" ], "x-required-scope": { "scope": "urls", "ability": "write" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "schema_template": { "type": "object" } }, "required": [ "schema_template" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object" } } } }, "example": { "valid": true, "errors": [] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores": { "get": { "summary": "List datastores", "description": "Returns a paginated list of datastores.", "operationId": "api.endpoint.datastores.list", "tags": [ "Datastores" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "engine", "in": "query", "required": false, "description": "The engine type of the datastore You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "airtable", "dynamodb", "google-sheets", "mariadb", "memcached", "mongodb", "mysql", "notion", "postgresql", "redis", "sql-server", "sqlite", "supabase" ] } }, { "name": "storage", "in": "query", "required": false, "description": "The storage type of the datastore You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "tabular", "document", "key_value" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "storage": { "type": "string" }, "engine": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "last_synced_at": { "type": "string" }, "has_last_sync_error": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/datastores", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "dat_8JdBoLy6p9jk0M7N", "object": "datastore", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "storage": "key_value", "engine": "redis", "name": "Primary Redis", "description": "Session and cache datastore", "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "connection_name": "Production Redis", "has_valid_auth": true, "last_synced_at": "2026-06-08T23:54:48+00:00", "has_last_sync_error": false, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores/{id}": { "get": { "summary": "Get a datastore", "description": "Returns the datastore with the given ID.", "operationId": "api.endpoint.datastores.get", "tags": [ "Datastores" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "storage": { "type": "string" }, "engine": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "last_synced_at": { "type": "string" }, "has_last_sync_error": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_8JdBoLy6p9jk0M7N", "object": "datastore", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "storage": "key_value", "engine": "redis", "name": "Primary Redis", "description": "Session and cache datastore", "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "connection_name": "Production Redis", "has_valid_auth": true, "last_synced_at": "2026-06-08T23:54:48+00:00", "has_last_sync_error": false, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores/{datastore}/schema": { "get": { "summary": "List datastore schema containers", "description": "Returns all schema containers for the given datastore ID.", "operationId": "api.endpoint.datastores.schema.list", "tags": [ "Datastore schema" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "name": { "type": "string" }, "connection_id": { "type": "string" }, "fields": { "type": "object", "properties": { "id": { "type": "null" }, "connection_id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "data_type": { "type": "string" }, "path": { "type": "string" }, "is_array": { "type": "boolean" }, "primary_key_position": { "type": "integer" }, "behavior": { "type": "string" }, "value_generation": { "type": "string" }, "is_nullable": { "type": "boolean" }, "max_length": { "type": "integer" }, "numeric_precision": { "type": "integer" }, "numeric_scale": { "type": "integer" }, "option_values": { "type": "array", "items": { "type": "string" } }, "default_value": { "type": "null" }, "is_readable": { "type": "boolean" }, "is_writeable": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_write_only": { "type": "boolean" } } }, "resource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "null" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object", "properties": { "output_type": { "type": "string" }, "result_key": { "type": "string" } } } } } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "example": [ { "id": "dat_cnt_o34rQpb2K8mV15Dg", "object": "datastore_container", "datastore": "dat_8JdBoLy6p9jk0M7N", "name": "products", "connection_id": "products", "fields": { "id": null, "connection_id": "title", "key": "title", "name": "Title", "description": "Product title", "data_type": "string", "path": "details.title", "is_array": false, "primary_key_position": 1, "behavior": "created_at", "value_generation": "uuid", "is_nullable": true, "max_length": 255, "numeric_precision": 10, "numeric_scale": 2, "option_values": [ "draft", "published" ], "default_value": null, "is_readable": true, "is_writeable": true, "is_read_only": false, "is_write_only": false }, "resource": { "id": "dat_res_61xABJZXxZGXL9Qo", "name": null, "is_default": true, "schema_template": { "fields": { "path": "title", "value": { "output_type": "string", "result_key": "title" } } } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores/{datastore}/schema/{id}": { "get": { "summary": "Get datastore schema container", "description": "Returns the schema container with the given ID for the given datastore ID.", "operationId": "api.endpoint.datastores.schema.get", "tags": [ "Datastore schema" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "name": { "type": "string" }, "connection_id": { "type": "string" }, "fields": { "type": "object", "properties": { "id": { "type": "null" }, "connection_id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "data_type": { "type": "string" }, "path": { "type": "string" }, "is_array": { "type": "boolean" }, "primary_key_position": { "type": "integer" }, "behavior": { "type": "string" }, "value_generation": { "type": "string" }, "is_nullable": { "type": "boolean" }, "max_length": { "type": "integer" }, "numeric_precision": { "type": "integer" }, "numeric_scale": { "type": "integer" }, "option_values": { "type": "array", "items": { "type": "string" } }, "default_value": { "type": "null" }, "is_readable": { "type": "boolean" }, "is_writeable": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_write_only": { "type": "boolean" } } }, "resource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "null" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object", "properties": { "output_type": { "type": "string" }, "result_key": { "type": "string" } } } } } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_cnt_o34rQpb2K8mV15Dg", "object": "datastore_container", "datastore": "dat_8JdBoLy6p9jk0M7N", "name": "products", "connection_id": "products", "fields": { "id": null, "connection_id": "title", "key": "title", "name": "Title", "description": "Product title", "data_type": "string", "path": "details.title", "is_array": false, "primary_key_position": 1, "behavior": "created_at", "value_generation": "uuid", "is_nullable": true, "max_length": 255, "numeric_precision": 10, "numeric_scale": 2, "option_values": [ "draft", "published" ], "default_value": null, "is_readable": true, "is_writeable": true, "is_read_only": false, "is_write_only": false }, "resource": { "id": "dat_res_61xABJZXxZGXL9Qo", "name": null, "is_default": true, "schema_template": { "fields": { "path": "title", "value": { "output_type": "string", "result_key": "title" } } } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update datastore schema container", "description": "Updates editable schema field metadata for the container with the given ID for the given datastore ID.", "operationId": "api.endpoint.datastores.schema.update", "tags": [ "Datastore schema" ], "x-required-scope": { "scope": "datastores", "ability": "write" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "id": { "type": "string" }, "behavior": { "type": "string", "enum": [ "created_at", "encrypted", "password", "slug", "soft_delete", "tenant", "updated_at" ] }, "is_readable": { "type": "boolean" }, "is_writeable": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_write_only": { "type": "boolean" } } } }, "required": [ "fields" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "name": { "type": "string" }, "connection_id": { "type": "string" }, "fields": { "type": "object", "properties": { "id": { "type": "null" }, "connection_id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "data_type": { "type": "string" }, "path": { "type": "string" }, "is_array": { "type": "boolean" }, "primary_key_position": { "type": "integer" }, "behavior": { "type": "string" }, "value_generation": { "type": "string" }, "is_nullable": { "type": "boolean" }, "max_length": { "type": "integer" }, "numeric_precision": { "type": "integer" }, "numeric_scale": { "type": "integer" }, "option_values": { "type": "array", "items": { "type": "string" } }, "default_value": { "type": "null" }, "is_readable": { "type": "boolean" }, "is_writeable": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_write_only": { "type": "boolean" } } }, "resource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "null" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object", "properties": { "output_type": { "type": "string" }, "result_key": { "type": "string" } } } } } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_cnt_o34rQpb2K8mV15Dg", "object": "datastore_container", "datastore": "dat_8JdBoLy6p9jk0M7N", "name": "products", "connection_id": "products", "fields": { "id": null, "connection_id": "title", "key": "title", "name": "Title", "description": "Product title", "data_type": "string", "path": "details.title", "is_array": false, "primary_key_position": 1, "behavior": "created_at", "value_generation": "uuid", "is_nullable": true, "max_length": 255, "numeric_precision": 10, "numeric_scale": 2, "option_values": [ "draft", "published" ], "default_value": null, "is_readable": true, "is_writeable": true, "is_read_only": false, "is_write_only": false }, "resource": { "id": "dat_res_61xABJZXxZGXL9Qo", "name": null, "is_default": true, "schema_template": { "fields": { "path": "title", "value": { "output_type": "string", "result_key": "title" } } } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores/{datastore}/resources": { "get": { "summary": "List datastore resources", "description": "Returns all resources for the given datastore ID.", "operationId": "api.endpoint.datastores.resources.list", "tags": [ "Datastore resources" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "container": { "type": "string" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "null" } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "example": [ { "id": "dat_res_61xABJZXxZGXL9Qo", "object": "datastore_resource", "datastore": "dat_8JdBoLy6p9jk0M7N", "container": "dat_cnt_o34rQpb2K8mV15Dg", "name": "Catalog product payload", "is_default": true, "schema_template": { "fields": { "path": "title", "value": null } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create datastore resource", "description": "Creates and returns a datastore resource for the given datastore ID.", "operationId": "api.endpoint.datastores.resources.create", "tags": [ "Datastore resources" ], "x-required-scope": { "scope": "datastores", "ability": "write" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "container": { "type": "string" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object", "properties": { "output_type": { "type": "string", "enum": [ "angle", "area", "barcode", "bool", "bytes", "color", "country", "currency", "date", "datetime", "dimension", "duration", "email", "ip_address", "json", "locale", "money", "number", "percentage", "phone_number", "string", "temperature", "time", "timezone", "url", "uuid", "volume", "weight" ] }, "result_key": { "type": "string" }, "fixed": { "type": "object" }, "country_result_key": { "type": "string" }, "fallback_country_code": { "type": "string" }, "currency_result_key": { "type": "string" }, "fallback_currency_code": { "type": "string" }, "conversion_currency_code": { "type": "string" }, "unit_result_key": { "type": "string" }, "fallback_unit": { "type": "string" }, "conversion_unit": { "type": "string" } } } } } } } }, "required": [ "container" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "container": { "type": "string" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "null" } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_res_61xABJZXxZGXL9Qo", "object": "datastore_resource", "datastore": "dat_8JdBoLy6p9jk0M7N", "container": "dat_cnt_o34rQpb2K8mV15Dg", "name": "Catalog product payload", "is_default": true, "schema_template": { "fields": { "path": "title", "value": null } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/datastores/{datastore}/resources/{id}": { "get": { "summary": "Get datastore resource", "description": "Returns the datastore resource with the given ID for the given datastore ID.", "operationId": "api.endpoint.datastores.resources.get", "tags": [ "Datastore resources" ], "x-required-scope": { "scope": "datastores", "ability": "read" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "container": { "type": "string" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "null" } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_res_61xABJZXxZGXL9Qo", "object": "datastore_resource", "datastore": "dat_8JdBoLy6p9jk0M7N", "container": "dat_cnt_o34rQpb2K8mV15Dg", "name": "Catalog product payload", "is_default": true, "schema_template": { "fields": { "path": "title", "value": null } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update datastore resource", "description": "Updates and returns the datastore resource with the given ID for the given datastore ID.", "operationId": "api.endpoint.datastores.resources.update", "tags": [ "Datastore resources" ], "x-required-scope": { "scope": "datastores", "ability": "write" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object", "properties": { "output_type": { "type": "string", "enum": [ "angle", "area", "barcode", "bool", "bytes", "color", "country", "currency", "date", "datetime", "dimension", "duration", "email", "ip_address", "json", "locale", "money", "number", "percentage", "phone_number", "string", "temperature", "time", "timezone", "url", "uuid", "volume", "weight" ] }, "result_key": { "type": "string" }, "fixed": { "type": "object" }, "country_result_key": { "type": "string" }, "fallback_country_code": { "type": "string" }, "currency_result_key": { "type": "string" }, "fallback_currency_code": { "type": "string" }, "conversion_currency_code": { "type": "string" }, "unit_result_key": { "type": "string" }, "fallback_unit": { "type": "string" }, "conversion_unit": { "type": "string" } } } } } } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "datastore": { "type": "string" }, "container": { "type": "string" }, "name": { "type": "string" }, "is_default": { "type": "boolean" }, "schema_template": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "null" } } } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "dat_res_61xABJZXxZGXL9Qo", "object": "datastore_resource", "datastore": "dat_8JdBoLy6p9jk0M7N", "container": "dat_cnt_o34rQpb2K8mV15Dg", "name": "Catalog product payload", "is_default": true, "schema_template": { "fields": { "path": "title", "value": null } }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete datastore resource", "description": "Deletes the datastore resource with the given ID for the given datastore ID.", "operationId": "api.endpoint.datastores.resources.delete", "tags": [ "Datastore resources" ], "x-required-scope": { "scope": "datastores", "ability": "delete" }, "parameters": [ { "name": "datastore", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "dat_res_61xABJZXxZGXL9Qo", "object": "datastore_resource", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/filestores": { "get": { "summary": "List filestores", "description": "Returns a paginated list of filestores.", "operationId": "api.endpoint.filestores.list", "tags": [ "Filestores" ], "x-required-scope": { "scope": "filestores", "ability": "read" }, "parameters": [ { "name": "disk", "in": "query", "required": false, "description": "The storage disk of the filestore You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "amazon-s3", "cloudflare-r2", "dropbox", "ftp", "sftp", "google-drive" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "disk": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/filestores", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "fls_lbyQPxYo803aErAg", "object": "filestore", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "disk": "amazon-s3", "name": "Main file bucket", "description": "Assets and uploads", "connection_name": "Production S3", "has_valid_auth": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/filestores/{id}": { "get": { "summary": "Get a filestore", "description": "Returns the filestore with the given ID.", "operationId": "api.endpoint.filestores.get", "tags": [ "Filestores" ], "x-required-scope": { "scope": "filestores", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "disk": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "fls_lbyQPxYo803aErAg", "object": "filestore", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "disk": "amazon-s3", "name": "Main file bucket", "description": "Assets and uploads", "connection_name": "Production S3", "has_valid_auth": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/integrations": { "get": { "summary": "List integrations", "description": "Returns a paginated list of integrations.", "operationId": "api.endpoint.integrations.list", "tags": [ "Integrations" ], "x-required-scope": { "scope": "integrations", "ability": "read" }, "parameters": [ { "name": "service", "in": "query", "required": false, "description": "The service of the integration You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "amazon-ses", "gmail", "google-calendar", "google-forms", "ical", "mailgun", "microsoft-outlook", "openai", "postmark", "resend", "slack", "twilio" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "service": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/integrations", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "ing_WOmY6nweGkog9KJ4", "object": "integration", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "service": "slack", "name": "Slack Ops", "description": "Syncs rows to analytics sheet", "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "connection_name": "Production Workspace", "has_valid_auth": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/integrations/{id}": { "get": { "summary": "Get an integration", "description": "Returns the integration with the given ID.", "operationId": "api.endpoint.integrations.get", "tags": [ "Integrations" ], "x-required-scope": { "scope": "integrations", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "projects": { "type": "array", "items": { "type": "string" } }, "service": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "default_country": { "type": "string" }, "default_currency": { "type": "string" }, "default_locale": { "type": "string" }, "default_timezone": { "type": "string" }, "connection_name": { "type": "string" }, "has_valid_auth": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "ing_WOmY6nweGkog9KJ4", "object": "integration", "projects": [ "prj_xRL9Jloy4gKXpnNj" ], "service": "slack", "name": "Slack Ops", "description": "Syncs rows to analytics sheet", "default_country": "US", "default_currency": "USD", "default_locale": "en_US", "default_timezone": "UTC", "connection_name": "Production Workspace", "has_valid_auth": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/projects/{project}/env-vars": { "get": { "summary": "List project environment variables", "description": "Returns all environment variables for the given project ID.", "operationId": "api.endpoint.projects.env-vars.list", "tags": [ "Environment variables" ], "x-required-scope": { "scope": "project_env_vars", "ability": "read" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "example": [ { "id": "API_TOKEN", "object": "project_env_var", "value": "sk_live_xxx", "description": "Token used by outbound API calls", "is_secret": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a project environment variable", "description": "Creates and returns an environment variable for the given project ID.", "operationId": "api.endpoint.projects.env-vars.create", "tags": [ "Environment variables" ], "x-required-scope": { "scope": "project_env_vars", "ability": "write" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" } }, "required": [ "key" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "API_TOKEN", "object": "project_env_var", "value": "sk_live_xxx", "description": "Token used by outbound API calls", "is_secret": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/projects/{project}/env-vars/{id}": { "get": { "summary": "Get a project environment variable", "description": "Returns the environment variable with the given key for the given project ID.", "operationId": "api.endpoint.projects.env-vars.get", "tags": [ "Environment variables" ], "x-required-scope": { "scope": "project_env_vars", "ability": "read" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "API_TOKEN", "object": "project_env_var", "value": "sk_live_xxx", "description": "Token used by outbound API calls", "is_secret": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a project environment variable", "description": "Updates and returns the environment variable with the given key for the given project ID.", "operationId": "api.endpoint.projects.env-vars.update", "tags": [ "Environment variables" ], "x-required-scope": { "scope": "project_env_vars", "ability": "write" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "is_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "API_TOKEN", "object": "project_env_var", "value": "sk_live_xxx", "description": "Token used by outbound API calls", "is_secret": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a project environment variable", "description": "Deletes the environment variable with the given key for the given project ID.", "operationId": "api.endpoint.projects.env-vars.delete", "tags": [ "Environment variables" ], "x-required-scope": { "scope": "project_env_vars", "ability": "delete" }, "parameters": [ { "name": "project", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "API_TOKEN", "object": "project_env_var", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/account": { "get": { "summary": "Get current account", "description": "Gets the account object for the account that the provided API Key authenticates.", "operationId": "api.endpoint.account.get", "tags": [ "Account details" ], "x-required-scope": { "scope": "account", "ability": "read" }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "plan": { "type": "null" }, "status": { "type": "null" }, "name": { "type": "string" }, "image_url": { "type": "null" }, "country": { "type": "string" }, "currency": { "type": "string" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "usage": { "type": "object", "properties": { "anchor_at": { "type": "string" }, "cycle": { "type": "string" }, "metrics_allowance_exceeded": { "type": "array", "items": { "type": "object" } } } }, "subscription": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "null" }, "cycle": { "type": "string" }, "minimum_commitment": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "value": { "type": "integer" }, "value_formatted": { "type": "string" }, "display": { "type": "string" } } }, "billable_cap": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "value": { "type": "integer" }, "value_formatted": { "type": "string" }, "display": { "type": "string" } } }, "billable_add_ons": { "type": "array", "items": { "type": "object" } }, "is_billable_cap_amount_exceeded": { "type": "boolean" } } }, "issues": { "type": "object", "properties": { "status": { "type": "string" }, "reason": { "type": "null" }, "note": { "type": "null" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "acc_JLwKonPmgvGldWr2", "object": "account", "plan": null, "status": null, "name": "My Streamnode Account", "image_url": null, "country": "US", "currency": "USD", "locale": "en_US", "timezone": "UTC", "usage": { "anchor_at": "2026-06-08T23:54:48+00:00", "cycle": "month", "metrics_allowance_exceeded": [] }, "subscription": { "id": "sub_lpaVB2kw3kM9vmjb", "status": null, "cycle": "month", "minimum_commitment": { "amount": 100, "currency": "USD", "value": 1, "value_formatted": "1.00", "display": "$1.00" }, "billable_cap": { "amount": 100, "currency": "USD", "value": 1, "value_formatted": "1.00", "display": "$1.00" }, "billable_add_ons": [], "is_billable_cap_amount_exceeded": false }, "issues": { "status": "under_review", "reason": null, "note": null, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" }, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/users": { "get": { "summary": "List users", "description": "Returns a paginated list of users.", "operationId": "api.endpoint.users.list", "tags": [ "Users" ], "x-required-scope": { "scope": "users", "ability": "read" }, "parameters": [ { "name": "role", "in": "query", "required": false, "description": "The role of the user You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "usr_rol_GlqVbY8QOB3aZ4N7" ] }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "phone": { "type": "object", "properties": { "country": { "type": "string" }, "number": { "type": "string" }, "display": { "type": "string" } } }, "is_email_verified": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "last_login_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/users", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "usr_q9P1JBdQYd50LNEp", "object": "user", "email": "jane@example.com", "name": "Jane Doe", "display_name": "Jane Doe", "phone": { "country": "US", "number": "5865029983", "display": "+5865029983" }, "is_email_verified": true, "is_owner": false, "roles": [ "Admin" ], "last_login_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/users/{id}": { "get": { "summary": "Get a user", "description": "Returns the user with the given ID. Use `me` to return the profile for the user who authorized the OAuth session.", "operationId": "api.endpoint.users.get", "tags": [ "Users" ], "x-required-scope": { "scope": "users", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "phone": { "type": "object", "properties": { "country": { "type": "string" }, "number": { "type": "string" }, "display": { "type": "string" } } }, "is_email_verified": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "last_login_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "usr_q9P1JBdQYd50LNEp", "object": "user", "email": "jane@example.com", "name": "Jane Doe", "display_name": "Jane Doe", "phone": { "country": "US", "number": "5865029983", "display": "+5865029983" }, "is_email_verified": true, "is_owner": false, "roles": [ "Admin" ], "last_login_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/events": { "get": { "summary": "List events", "description": "Returns a paginated list of events.", "operationId": "api.endpoint.events.list", "tags": [ "Events" ], "x-required-scope": { "scope": "events", "ability": "read" }, "parameters": [ { "name": "event", "in": "query", "required": false, "description": "The code of the event You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "account.created", "account.updated", "account.deleted", "account.restored", "account.setting_changed", "account_image.created", "account_image.updated", "account_image.deleted", "account_image.restored", "user.created", "user.updated", "user.deleted", "user.restored", "user.login", "user.logout", "user.other_devices_logout", "user.email_verified", "user.password_reset_request", "user.password_changed", "user.account.added", "user.account.removed", "user.account.role_changed", "user.account.ownership_changed", "user_passkey.created", "user_passkey.updated", "user_passkey.deleted", "user_passkey.restored", "subscription.created", "subscription.updated", "subscription.deleted", "subscription.restored", "invoice.created", "invoice.updated", "invoice.deleted", "invoice.restored", "invoice_line_item.created", "invoice_line_item.updated", "invoice_line_item.deleted", "invoice_line_item.restored", "datastore.created", "datastore.updated", "datastore.deleted", "datastore.restored", "datastore.connected", "datastore.disconnected", "datastore.synchronized", "datastore.setting_changed", "datastore.project_added", "datastore.project_removed", "datastore_resource.created", "datastore_resource.updated", "datastore_resource.deleted", "datastore_resource.restored", "filestore.created", "filestore.updated", "filestore.deleted", "filestore.restored", "filestore.connected", "filestore.disconnected", "filestore.setting_changed", "filestore.project_added", "filestore.project_removed", "integration.created", "integration.updated", "integration.deleted", "integration.restored", "integration.connected", "integration.disconnected", "integration.synchronized", "integration.setting_changed", "integration.project_added", "integration.project_removed", "domain.created", "domain.updated", "domain.deleted", "domain.restored", "project.created", "project.updated", "project.deleted", "project.restored", "project.setting_changed", "project_image.created", "project_image.updated", "project_image.deleted", "project_image.restored", "project_guard.created", "project_guard.updated", "project_guard.deleted", "project_guard.restored", "project_guard_image.created", "project_guard_image.updated", "project_guard_image.deleted", "project_guard_image.restored", "url.created", "url.updated", "url.deleted", "url.restored", "public_app.created", "public_app.updated", "public_app.deleted", "public_app.restored", "public_app_image.created", "public_app_image.updated", "public_app_image.deleted", "public_app_image.restored", "webhook.created", "webhook.updated", "webhook.deleted", "webhook.restored" ] } }, { "name": "date", "in": "query", "required": false, "description": "The date the event happend You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-06-08T00:00:00+00:00" }, { "name": "ip", "in": "query", "required": false, "description": "The IP associated with the event You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "event": { "type": "string" }, "account_id": { "type": "string" }, "api_version": { "type": "string" }, "happened_at": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/events", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "evt_EeAWm6nmX54bKzYd", "object": "event", "event": "domain.created", "account_id": "acc_JLwKonPmgvGldWr2", "api_version": "latest", "happened_at": "2026-06-08T23:54:48+00:00", "data": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/events/{id}": { "get": { "summary": "Get an event", "description": "Returns the event with the given ID.", "operationId": "api.endpoint.events.get", "tags": [ "Events" ], "x-required-scope": { "scope": "events", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "event": { "type": "string" }, "account_id": { "type": "string" }, "api_version": { "type": "string" }, "happened_at": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_system": { "type": "boolean" }, "dns": { "type": "object", "properties": { "verification_status": { "type": "string" }, "requirements": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "null" }, "is_mandatory": { "type": "boolean" }, "verification_status": { "type": "string" } } } } }, "is_ownership_verified": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } }, "example": { "id": "evt_EeAWm6nmX54bKzYd", "object": "event", "event": "domain.created", "account_id": "acc_JLwKonPmgvGldWr2", "api_version": "latest", "happened_at": "2026-06-08T23:54:48+00:00", "data": { "id": "dom_Z2OKaB7mdjwXJ15g", "object": "domain", "project": "prj_xRL9Jloy4gKXpnNj", "status": "active", "name": "link.example.com", "type": "custom", "is_system": false, "dns": { "verification_status": "valid", "requirements": { "type": "CNAME", "name": "www", "value": null, "is_mandatory": true, "verification_status": "valid" } }, "is_ownership_verified": true, "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/webhooks": { "get": { "summary": "List webhooks", "description": "Returns a paginated list of webhooks.", "operationId": "api.endpoint.webhooks.list", "tags": [ "Webhooks" ], "x-required-scope": { "scope": "webhooks", "ability": "read" }, "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Filter webhooks by status. You can also include this filter inside the `filters` JSON parameter.", "schema": { "type": "string", "enum": [ "enabled", "disabled" ] } }, { "name": "filters", "in": "query", "required": false, "description": "Advanced filter expression as JSON. Use this for complex logic, nested conditions, or explicit comparisons.", "schema": { "type": "object" } }, { "name": "cursor", "in": "query", "required": false, "description": "A cursor for use in pagination. Provide the `cursor` value returned by the previous list response to fetch the next page.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "A limit on how many objects are returned. Limit can be between 10 and 100, the default is 10.", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" }, "has_more": { "type": "boolean" }, "next_id": { "type": "null" }, "next_url": { "type": "null" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "api_version": { "type": "null" }, "url": { "type": "string" }, "secret": { "type": "string" }, "description": { "type": "string" }, "are_all_events_subscribed": { "type": "boolean" }, "subscribed_events": { "type": "array", "items": { "type": "string" } }, "http_auth_username": { "type": "null" }, "http_auth_password": { "type": "null" }, "headers": { "type": "null" }, "last_sent_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "example": { "object": "list", "url": "https://api.streamnode.io/v1/webhooks", "has_more": false, "next_id": null, "next_url": null, "data": [ { "id": "wh_oRa9A7PD8PgxQe8r", "object": "webhook", "status": "enabled", "api_version": null, "url": "https://example.com/webhook", "secret": "wbksec_WLRlkmNqVhomvG1fPHu0Xh8RbYB0R60DxOU9HRqJ", "description": "This is a lovely webhook", "are_all_events_subscribed": false, "subscribed_events": [ { "value": "url.created", "label": "url.created" } ], "http_auth_username": null, "http_auth_password": null, "headers": null, "last_sent_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } ] } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Create a webhook", "description": "Creates and returns a webhook.", "operationId": "api.endpoint.webhooks.create", "tags": [ "Webhooks" ], "x-required-scope": { "scope": "webhooks", "ability": "write" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] }, "api_version": { "type": "string", "enum": [ "latest", "2026-03-01" ] }, "url": { "type": "string" }, "description": { "type": "string" }, "subscribed_events": { "type": "array", "items": { "type": "string", "enum": [ "account.created", "account.updated", "account.setting_changed", "subscription.created", "subscription.updated", "subscription.deleted", "invoice.created", "invoice.updated", "invoice.deleted", "invoice_line_item.created", "invoice_line_item.updated", "invoice_line_item.deleted", "datastore.created", "datastore.updated", "datastore.deleted", "datastore.connected", "datastore.disconnected", "datastore.synchronized", "datastore.setting_changed", "datastore.project_added", "datastore.project_removed", "datastore_resource.created", "datastore_resource.updated", "datastore_resource.deleted", "filestore.created", "filestore.updated", "filestore.deleted", "filestore.connected", "filestore.disconnected", "filestore.setting_changed", "filestore.project_added", "filestore.project_removed", "integration.created", "integration.updated", "integration.deleted", "integration.connected", "integration.disconnected", "integration.synchronized", "integration.setting_changed", "integration.project_added", "integration.project_removed", "domain.created", "domain.updated", "domain.deleted", "project.created", "project.updated", "project.deleted", "project.setting_changed", "url.created", "url.updated", "url.deleted" ] } }, "http_auth_username": { "type": "string" }, "http_auth_password": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "url", "subscribed_events" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "api_version": { "type": "null" }, "url": { "type": "string" }, "secret": { "type": "string" }, "description": { "type": "string" }, "are_all_events_subscribed": { "type": "boolean" }, "subscribed_events": { "type": "array", "items": { "type": "string" } }, "http_auth_username": { "type": "null" }, "http_auth_password": { "type": "null" }, "headers": { "type": "null" }, "last_sent_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "wh_oRa9A7PD8PgxQe8r", "object": "webhook", "status": "enabled", "api_version": null, "url": "https://example.com/webhook", "secret": "wbksec_WLRlkmNqVhomvG1fPHu0Xh8RbYB0R60DxOU9HRqJ", "description": "This is a lovely webhook", "are_all_events_subscribed": false, "subscribed_events": [ { "value": "url.created", "label": "url.created" } ], "http_auth_username": null, "http_auth_password": null, "headers": null, "last_sent_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/webhooks/{id}": { "get": { "summary": "Get a webhook", "description": "Returns the webhook with the given ID.", "operationId": "api.endpoint.webhooks.get", "tags": [ "Webhooks" ], "x-required-scope": { "scope": "webhooks", "ability": "read" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "api_version": { "type": "null" }, "url": { "type": "string" }, "secret": { "type": "string" }, "description": { "type": "string" }, "are_all_events_subscribed": { "type": "boolean" }, "subscribed_events": { "type": "array", "items": { "type": "string" } }, "http_auth_username": { "type": "null" }, "http_auth_password": { "type": "null" }, "headers": { "type": "null" }, "last_sent_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "wh_oRa9A7PD8PgxQe8r", "object": "webhook", "status": "enabled", "api_version": null, "url": "https://example.com/webhook", "secret": "wbksec_WLRlkmNqVhomvG1fPHu0Xh8RbYB0R60DxOU9HRqJ", "description": "This is a lovely webhook", "are_all_events_subscribed": false, "subscribed_events": [ { "value": "url.created", "label": "url.created" } ], "http_auth_username": null, "http_auth_password": null, "headers": null, "last_sent_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Update a webhook", "description": "Updates and returns the webhook with the given ID.", "operationId": "api.endpoint.webhooks.update", "tags": [ "Webhooks" ], "x-required-scope": { "scope": "webhooks", "ability": "write" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] }, "api_version": { "type": "string", "enum": [ "latest", "2026-03-01" ] }, "url": { "type": "string" }, "description": { "type": "string" }, "subscribed_events": { "type": "array", "items": { "type": "string", "enum": [ "account.created", "account.updated", "account.setting_changed", "subscription.created", "subscription.updated", "subscription.deleted", "invoice.created", "invoice.updated", "invoice.deleted", "invoice_line_item.created", "invoice_line_item.updated", "invoice_line_item.deleted", "datastore.created", "datastore.updated", "datastore.deleted", "datastore.connected", "datastore.disconnected", "datastore.synchronized", "datastore.setting_changed", "datastore.project_added", "datastore.project_removed", "datastore_resource.created", "datastore_resource.updated", "datastore_resource.deleted", "filestore.created", "filestore.updated", "filestore.deleted", "filestore.connected", "filestore.disconnected", "filestore.setting_changed", "filestore.project_added", "filestore.project_removed", "integration.created", "integration.updated", "integration.deleted", "integration.connected", "integration.disconnected", "integration.synchronized", "integration.setting_changed", "integration.project_added", "integration.project_removed", "domain.created", "domain.updated", "domain.deleted", "project.created", "project.updated", "project.deleted", "project.setting_changed", "url.created", "url.updated", "url.deleted" ] } }, "http_auth_username": { "type": "string" }, "http_auth_password": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "api_version": { "type": "null" }, "url": { "type": "string" }, "secret": { "type": "string" }, "description": { "type": "string" }, "are_all_events_subscribed": { "type": "boolean" }, "subscribed_events": { "type": "array", "items": { "type": "string" } }, "http_auth_username": { "type": "null" }, "http_auth_password": { "type": "null" }, "headers": { "type": "null" }, "last_sent_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "example": { "id": "wh_oRa9A7PD8PgxQe8r", "object": "webhook", "status": "enabled", "api_version": null, "url": "https://example.com/webhook", "secret": "wbksec_WLRlkmNqVhomvG1fPHu0Xh8RbYB0R60DxOU9HRqJ", "description": "This is a lovely webhook", "are_all_events_subscribed": false, "subscribed_events": [ { "value": "url.created", "label": "url.created" } ], "http_auth_username": null, "http_auth_password": null, "headers": null, "last_sent_at": "2026-06-08T23:54:48+00:00", "created_at": "2026-06-08T23:54:48+00:00", "updated_at": "2026-06-08T23:54:48+00:00" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "summary": "Delete a webhook", "description": "Deletes the webhook with the given ID.", "operationId": "api.endpoint.webhooks.delete", "tags": [ "Webhooks" ], "x-required-scope": { "scope": "webhooks", "ability": "delete" }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Path parameter.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": "wh_oRa9A7PD8PgxQe8r", "object": "webhook", "deleted": true } } } } }, "security": [ { "bearerAuth": [] } ] } } } }