{"openapi":"3.1.0","info":{"title":"Rebrandly Domains (BYOK) API","version":"0.1.0","description":"Rebrandly Domains (BYOK) lets an AI assistant read your own Rebrandly Domains data through the Rebrandly Domains API with a key you supply (Rebrandly API key). Read-only: 7 tools (list_account_domains, get_account_domain, count_account_domains, search_account_domains, list_domain_subdomains, list_domain_workspaces, list_workspace_domains). The BYOK key travels with each request, is used for that...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-rebrandly-account-domains.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-rebrandly-account-domains/docs"},"termsOfService":"https://connectorbay.com/byok-rebrandly-account-domains/terms"},"servers":[{"url":"https://byok-rebrandly-account-domains.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-rebrandly-account-domains/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_account_domains":{"post":{"operationId":"list_account_domains","summary":"List the domains owned by the account with DNS and subscription status, subdomain count, nameservers, auto-renew flag, e","description":"List the domains owned by the account with DNS and subscription status, subdomain count, nameservers, auto-renew flag, expiry and homepage and fallback routing mode. Pages of up to 25; pass the last domain id as last. Use for \"Which custom domains do I own in Rebrandly and when do they expire\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, default createdAt.","title":"Order By"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"type":{"anyOf":[{"enum":["USER","SERVICE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only USER (your own) or SERVICE (Rebrandly's) domains.","title":"Type"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only active domains, false for the others.","title":"Active"}},"title":"list_account_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_account_domain":{"post":{"operationId":"get_account_domain","summary":"Get one account domain by ID with DNS and subscription status, nameservers, auto-renew, expiry and routing mode. Use for","description":"Get one account domain by ID with DNS and subscription status, nameservers, auto-renew, expiry and routing mode. Use for \"Show the details of this Rebrandly domain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_id":{"description":"Domain ID, 32 characters (from list_account_domains).","maxLength":64,"title":"Domain Id","type":"string"}},"required":["domain_id"],"title":"get_account_domainArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/count_account_domains":{"post":{"operationId":"count_account_domains","summary":"Count the domains owned by the account. Use for \"How many domains does my Rebrandly account own\".","description":"Count the domains owned by the account. Use for \"How many domains does my Rebrandly account own\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"count_account_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_account_domains":{"post":{"operationId":"search_account_domains","summary":"Search the account's domains by a text term (for example part of the domain name). Use for \"Find my Rebrandly domains th","description":"Search the account's domains by a text term (for example part of the domain name). Use for \"Find my Rebrandly domains that contain 'shop'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"description":"Search text matched against domain names.","maxLength":100,"title":"Term","type":"string"}},"required":["term"],"title":"search_account_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_domain_subdomains":{"post":{"operationId":"list_domain_subdomains","summary":"List the subdomains that belong to a parent domain, with status and routing mode. Use for \"Which subdomains does this Re","description":"List the subdomains that belong to a parent domain, with status and routing mode. Use for \"Which subdomains does this Rebrandly domain have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_id":{"description":"Domain ID, 32 characters (from list_account_domains).","maxLength":64,"title":"Domain Id","type":"string"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"}},"required":["domain_id"],"title":"list_domain_subdomainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_domain_workspaces":{"post":{"operationId":"list_domain_workspaces","summary":"List the workspaces that have a given domain attached, with workspace type, link counts and clicks. Use for \"Which Rebra","description":"List the workspaces that have a given domain attached, with workspace type, link counts and clicks. Use for \"Which Rebrandly workspaces use this domain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain_id":{"description":"Domain ID, 32 characters (from list_account_domains).","maxLength":64,"title":"Domain Id","type":"string"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"revoked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only revoked workspaces, false for the others.","title":"Revoked"}},"required":["domain_id"],"title":"list_domain_workspacesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_domains":{"post":{"operationId":"list_workspace_domains","summary":"List the domains available to one workspace (its own plus shared ones) with DNS and subscription status. Use for \"Which ","description":"List the domains available to one workspace (its own plus shared ones) with DNS and subscription status. Use for \"Which domains can workspace X use for short links\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace ID (from list_account_workspaces of the rebrandly-workspaces connector).","maxLength":64,"title":"Workspace Id","type":"string"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"type":{"anyOf":[{"enum":["user","system"],"type":"string"},{"type":"null"}],"default":null,"description":"Only user or system domains.","title":"Type"}},"required":["workspace_id"],"title":"list_workspace_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}