{ "openapi": "3.1.0", "info": { "title": "Indexaro API", "version": "1.0.0", "description": "Programmatic access to Indexaro indexing workflows. Authenticate with a Bearer JWT session token or an API key (`if_.`). API keys require a Pro or Agency plan." }, "servers": [ { "url": "https://app.indexaro.com", "description": "Production" } ], "components": { "schemas": { "ApiError": { "type": "object", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "format": "uri", "example": "https://api.indexaro.com/errors/not-found" }, "title": { "type": "string", "example": "Website not found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/api/v1/websites/ws_abc/submit-url" } } }, "SubmitUrlResponse": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "status": { "type": "string", "enum": [ "queued", "pending" ] }, "message": { "type": "string" }, "lockedUntil": { "type": "string", "format": "date-time", "nullable": true } } }, "BulkSubmitResponse": { "type": "object", "properties": { "accepted": { "type": "integer" }, "rejected": { "type": "integer" }, "quotaExhausted": { "type": "boolean" } } }, "WebsiteSummary": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "protocol": { "type": "string", "enum": [ "http", "https" ] }, "status": { "type": "string", "enum": [ "PENDING_VERIFICATION", "ACTIVE", "SUSPENDED" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "WebsiteListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteSummary" } } } }, "LoginResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true } } } } }, "UserProfileResponse": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true }, "mfaEnabled": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "BillingStatusResponse": { "type": "object", "properties": { "tier": { "type": "string", "enum": [ "FREE", "PRO", "AGENCY" ] }, "status": { "type": "string" }, "currentPeriodEnd": { "type": "string", "format": "date-time", "nullable": true }, "stripeCustomerId": { "type": "string", "nullable": true } } }, "CheckoutSessionResponse": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true } } }, "UrlImportResponse": { "type": "object", "properties": { "created": { "type": "integer" }, "skipped": { "type": "integer" }, "engines": { "type": "array", "items": { "type": "string" } } } }, "SitemapListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "engine": { "type": "string" }, "entryCount": { "type": "integer", "nullable": true }, "status": { "type": "string" } } } } } }, "QuotaResponse": { "type": "object", "properties": { "tier": { "type": "string", "enum": [ "FREE", "PRO", "AGENCY" ] }, "features": { "type": "object", "properties": { "apiAccess": { "type": "boolean" }, "bulkSubmitMax": { "type": "integer" }, "autoSubmit": { "type": "boolean" } } }, "today": { "type": "object", "additionalProperties": { "type": "object", "properties": { "used": { "type": "integer" }, "limit": { "type": "integer" }, "unlimited": { "type": "boolean" } } } } } }, "SubmissionListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "engine": { "type": "string" }, "indexingStatus": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } } } } }, "LoginRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string", "minLength": 1 }, "cf_turnstile_response": { "type": "string" } }, "required": [ "email", "password" ], "additionalProperties": false }, "RegisterRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "cf_turnstile_response": { "type": "string" } }, "required": [ "email", "password", "name" ], "additionalProperties": false }, "ForgotPasswordRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false }, "ResetPasswordRequest": { "type": "object", "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 }, "newPassword": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" } }, "required": [ "token", "newPassword" ], "additionalProperties": false }, "RefreshTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string", "minLength": 1 } }, "required": [ "refreshToken" ], "additionalProperties": false }, "CreateOrgRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "UpdateOrgRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "billingEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "additionalProperties": false }, "CreateWebsiteRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "protocol": { "default": "https", "type": "string", "enum": [ "http", "https" ] } }, "required": [ "name", "domain", "protocol" ], "additionalProperties": false }, "CreateApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "scopes": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "websites:read", "websites:write", "urls:submit", "urls:read", "sitemaps:read", "sitemaps:write", "reports:read" ] } } }, "required": [ "name", "scopes" ], "additionalProperties": false }, "SubmitUrlRequest": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "url": { "type": "string", "format": "uri" }, "priority": { "default": 0, "type": "number", "minimum": 0, "maximum": 10 } }, "required": [ "engine", "url", "priority" ], "additionalProperties": false }, "BulkSubmitRequest": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE" ] }, "urls": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "priority": { "default": 0, "type": "number", "minimum": 0, "maximum": 10 } }, "required": [ "url", "priority" ], "additionalProperties": false } } }, "required": [ "engine", "urls" ], "additionalProperties": false }, "VerificationMethodRequest": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "DNS", "META_TAG", "FILE" ] } }, "required": [ "method" ], "additionalProperties": false }, "AutoSubmitSaveRequest": { "type": "object", "properties": { "sitemapUrl": { "type": "string", "format": "uri" }, "dailyLimit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "engines": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] } }, "enabled": { "default": true, "type": "boolean" }, "resubmitAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 90 }, { "type": "null" } ] }, "submitIntervalHours": { "default": 6, "type": "integer", "minimum": 1, "maximum": 168 } }, "required": [ "sitemapUrl", "dailyLimit", "engines", "enabled", "submitIntervalHours" ], "additionalProperties": false }, "GscInspectRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ], "additionalProperties": false }, "InviteMemberRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "default": "MEMBER", "type": "string", "enum": [ "ADMIN", "MEMBER", "VIEWER" ] } }, "required": [ "email", "role" ], "additionalProperties": false }, "BillingCheckoutRequest": { "type": "object", "properties": { "priceId": { "type": "string", "enum": [ "pro_monthly", "pro_annual", "agency_monthly", "agency_annual" ] } }, "required": [ "priceId" ], "additionalProperties": false }, "NotificationPrefsRequest": { "type": "object", "properties": { "email": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "recipients": { "type": "string" } }, "required": [ "enabled", "recipients" ], "additionalProperties": false }, "slack": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "webhookUrl": { "type": "string" }, "channel": { "type": "string" } }, "required": [ "enabled", "webhookUrl", "channel" ], "additionalProperties": false }, "discord": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "webhookUrl": { "type": "string" } }, "required": [ "enabled", "webhookUrl" ], "additionalProperties": false }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "enabled", "url", "secret" ], "additionalProperties": false }, "events": { "type": "object", "properties": { "indexingChange": { "type": "boolean" }, "sitemapError": { "type": "boolean" }, "verificationRequired": { "type": "boolean" }, "billingAlert": { "type": "boolean" }, "usageLimit": { "type": "boolean" } }, "required": [ "indexingChange", "sitemapError", "verificationRequired", "billingAlert", "usageLimit" ], "additionalProperties": false } }, "required": [ "email", "slack", "discord", "webhook", "events" ], "additionalProperties": false }, "BingApiKeyRequest": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 10 } }, "required": [ "apiKey" ], "additionalProperties": false }, "GscImportRequest": { "type": "object", "properties": { "sites": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "siteUrl": { "type": "string", "minLength": 1 }, "domain": { "type": "string", "minLength": 1 }, "protocol": { "default": "https", "type": "string", "enum": [ "http", "https" ] }, "isDomainProperty": { "default": false, "type": "boolean" } }, "required": [ "siteUrl", "domain", "protocol", "isDomainProperty" ], "additionalProperties": false } } }, "required": [ "sites" ], "additionalProperties": false }, "AddSitemapRequest": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "engine", "url" ], "additionalProperties": false }, "UrlsImportRequest": { "type": "object", "properties": { "urls": { "minItems": 1, "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uri" } }, "engines": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] } } }, "required": [ "urls", "engines" ], "additionalProperties": false }, "UpdateProfileRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "additionalProperties": false }, "ChangePasswordRequest": { "type": "object", "properties": { "currentPassword": { "type": "string", "minLength": 1 }, "newPassword": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" } }, "required": [ "currentPassword", "newPassword" ], "additionalProperties": false }, "SubmitSitemapToEnginesRequest": { "type": "object", "properties": { "sitemapUrl": { "type": "string", "format": "uri" } }, "required": [ "sitemapUrl" ], "additionalProperties": false }, "SitemapBulkSubmitRequest": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "filter": { "type": "string", "enum": [ "not_submitted", "failed", "selected" ] }, "urls": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "engine", "filter" ], "additionalProperties": false }, "CreateAiPromptRequest": { "type": "object", "properties": { "prompt": { "type": "string", "minLength": 5, "maxLength": 300 } }, "required": [ "prompt" ], "additionalProperties": false }, "GoogleServiceAccountRequest": { "type": "object", "properties": { "json": { "type": "string", "minLength": 10 } }, "required": [ "json" ], "additionalProperties": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "apiKeyAuth": { "type": "http", "scheme": "bearer", "description": "API key in Authorization header: Bearer if_." } } }, "paths": { "/api/v1/auth/forgot-password": { "post": { "operationId": "POST__api_v1_auth_forgot_password", "summary": "Request password reset email", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": false } } } } } }, "/api/v1/auth/login": { "post": { "operationId": "POST__api_v1_auth_login", "summary": "Authenticate with email and password", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string", "minLength": 1 }, "cf_turnstile_response": { "type": "string" } }, "required": [ "email", "password" ], "additionalProperties": false } } } } } }, "/api/v1/auth/logout": { "post": { "operationId": "POST__api_v1_auth_logout", "summary": "POST /api/v1/auth/logout", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/auth/refresh": { "post": { "operationId": "POST__api_v1_auth_refresh", "summary": "Refresh access token", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshToken": { "type": "string", "minLength": 1 } }, "required": [ "refreshToken" ], "additionalProperties": false } } } } } }, "/api/v1/auth/register": { "post": { "operationId": "POST__api_v1_auth_register", "summary": "Create a new account", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Account created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "cf_turnstile_response": { "type": "string" } }, "required": [ "email", "password", "name" ], "additionalProperties": false } } } } } }, "/api/v1/auth/resend-verification": { "post": { "operationId": "POST__api_v1_auth_resend_verification", "summary": "POST /api/v1/auth/resend-verification", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/auth/reset-password": { "post": { "operationId": "POST__api_v1_auth_reset_password", "summary": "Reset password with token", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 }, "newPassword": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" } }, "required": [ "token", "newPassword" ], "additionalProperties": false } } } } } }, "/api/v1/organizations": { "post": { "operationId": "POST__api_v1_organizations", "summary": "Create organization", "tags": [ "API" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}": { "delete": { "operationId": "DELETE__api_v1_organizations__orgId_", "summary": "DELETE /api/v1/organizations/{orgId}", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_organizations__orgId_", "summary": "GET /api/v1/organizations/{orgId}", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "patch": { "operationId": "PATCH__api_v1_organizations__orgId_", "summary": "Update organization", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "billingEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/api-keys": { "get": { "operationId": "GET__api_v1_organizations__orgId__api_keys", "summary": "List API keys", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_organizations__orgId__api_keys", "summary": "Create API key (Pro/Agency)", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "201": { "description": "API key created (secret shown once)" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "scopes": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "websites:read", "websites:write", "urls:submit", "urls:read", "sitemaps:read", "sitemaps:write", "reports:read" ] } } }, "required": [ "name", "scopes" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/api-keys/{keyId}": { "delete": { "operationId": "DELETE__api_v1_organizations__orgId__api_keys__keyId_", "summary": "DELETE /api/v1/organizations/{orgId}/api-keys/{keyId}", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/organizations/{orgId}/billing": { "get": { "operationId": "GET__api_v1_organizations__orgId__billing", "summary": "Get subscription status", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Subscription status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatusResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "operationId": "POST__api_v1_organizations__orgId__billing", "summary": "Start Stripe checkout", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "201": { "description": "Stripe checkout session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutSessionResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "priceId": { "type": "string", "enum": [ "pro_monthly", "pro_annual", "agency_monthly", "agency_annual" ] } }, "required": [ "priceId" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/bing-apikey": { "delete": { "operationId": "DELETE__api_v1_organizations__orgId__bing_apikey", "summary": "DELETE /api/v1/organizations/{orgId}/bing-apikey", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_organizations__orgId__bing_apikey", "summary": "GET /api/v1/organizations/{orgId}/bing-apikey", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "put": { "operationId": "PUT__api_v1_organizations__orgId__bing_apikey", "summary": "Save Bing Webmaster API key", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 10 } }, "required": [ "apiKey" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/gsc/connect": { "post": { "operationId": "POST__api_v1_organizations__orgId__gsc_connect", "summary": "POST /api/v1/organizations/{orgId}/gsc/connect", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/organizations/{orgId}/gsc/import": { "post": { "operationId": "POST__api_v1_organizations__orgId__gsc_import", "summary": "Import GSC properties as websites", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sites": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "siteUrl": { "type": "string", "minLength": 1 }, "domain": { "type": "string", "minLength": 1 }, "protocol": { "default": "https", "type": "string", "enum": [ "http", "https" ] }, "isDomainProperty": { "default": false, "type": "boolean" } }, "required": [ "siteUrl", "domain", "protocol", "isDomainProperty" ], "additionalProperties": false } } }, "required": [ "sites" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/gsc/properties": { "get": { "operationId": "GET__api_v1_organizations__orgId__gsc_properties", "summary": "GET /api/v1/organizations/{orgId}/gsc/properties", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/organizations/{orgId}/gsc/sync": { "post": { "operationId": "POST__api_v1_organizations__orgId__gsc_sync", "summary": "POST /api/v1/organizations/{orgId}/gsc/sync", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/organizations/{orgId}/members": { "get": { "operationId": "GET__api_v1_organizations__orgId__members", "summary": "GET /api/v1/organizations/{orgId}/members", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_organizations__orgId__members", "summary": "Invite team member", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "201": { "description": "Invitation sent" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "default": "MEMBER", "type": "string", "enum": [ "ADMIN", "MEMBER", "VIEWER" ] } }, "required": [ "email", "role" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/members/{memberId}": { "delete": { "operationId": "DELETE__api_v1_organizations__orgId__members__memberId_", "summary": "DELETE /api/v1/organizations/{orgId}/members/{memberId}", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/organizations/{orgId}/notifications": { "get": { "operationId": "GET__api_v1_organizations__orgId__notifications", "summary": "GET /api/v1/organizations/{orgId}/notifications", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "put": { "operationId": "PUT__api_v1_organizations__orgId__notifications", "summary": "Update notification settings", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "recipients": { "type": "string" } }, "required": [ "enabled", "recipients" ], "additionalProperties": false }, "slack": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "webhookUrl": { "type": "string" }, "channel": { "type": "string" } }, "required": [ "enabled", "webhookUrl", "channel" ], "additionalProperties": false }, "discord": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "webhookUrl": { "type": "string" } }, "required": [ "enabled", "webhookUrl" ], "additionalProperties": false }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "enabled", "url", "secret" ], "additionalProperties": false }, "events": { "type": "object", "properties": { "indexingChange": { "type": "boolean" }, "sitemapError": { "type": "boolean" }, "verificationRequired": { "type": "boolean" }, "billingAlert": { "type": "boolean" }, "usageLimit": { "type": "boolean" } }, "required": [ "indexingChange", "sitemapError", "verificationRequired", "billingAlert", "usageLimit" ], "additionalProperties": false } }, "required": [ "email", "slack", "discord", "webhook", "events" ], "additionalProperties": false } } } } } }, "/api/v1/organizations/{orgId}/quota": { "get": { "operationId": "GET__api_v1_organizations__orgId__quota", "summary": "Organization quota and plan features", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Quota and plan features", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/organizations/{orgId}/websites": { "get": { "operationId": "GET__api_v1_organizations__orgId__websites", "summary": "List websites in organization", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Website list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteListResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "operationId": "POST__api_v1_organizations__orgId__websites", "summary": "Create a website", "tags": [ "Organizations" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "201": { "description": "Website created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteSummary" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "protocol": { "default": "https", "type": "string", "enum": [ "http", "https" ] } }, "required": [ "name", "domain", "protocol" ], "additionalProperties": false } } } } } }, "/api/v1/users/me": { "delete": { "operationId": "DELETE__api_v1_users_me", "summary": "DELETE /api/v1/users/me", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_users_me", "summary": "GET /api/v1/users/me", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Current user profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "PATCH__api_v1_users_me", "summary": "Update user profile", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "additionalProperties": false } } } } } }, "/api/v1/users/me/export": { "get": { "operationId": "GET__api_v1_users_me_export", "summary": "GET /api/v1/users/me/export", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/users/me/password": { "post": { "operationId": "POST__api_v1_users_me_password", "summary": "Change password", "tags": [ "Users" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentPassword": { "type": "string", "minLength": 1 }, "newPassword": { "type": "string", "minLength": 10, "pattern": "^(?=.*[A-Z])(?=.*[0-9])" } }, "required": [ "currentPassword", "newPassword" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}": { "delete": { "operationId": "DELETE__api_v1_websites__id_", "summary": "Delete a website", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/ai-prompts": { "get": { "operationId": "GET__api_v1_websites__id__ai_prompts", "summary": "GET /api/v1/websites/{id}/ai-prompts", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__ai_prompts", "summary": "Create AI visibility prompt", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "minLength": 5, "maxLength": 300 } }, "required": [ "prompt" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/ai-prompts/{promptId}": { "delete": { "operationId": "DELETE__api_v1_websites__id__ai_prompts__promptId_", "summary": "DELETE /api/v1/websites/{id}/ai-prompts/{promptId}", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/ai-visibility": { "get": { "operationId": "GET__api_v1_websites__id__ai_visibility", "summary": "GET /api/v1/websites/{id}/ai-visibility", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/analytics": { "get": { "operationId": "GET__api_v1_websites__id__analytics", "summary": "GET /api/v1/websites/{id}/analytics", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "days", "in": "query", "required": true, "schema": { "default": 30, "type": "number", "minimum": 7, "maximum": 90 } } ] } }, "/api/v1/websites/{id}/auto-submit": { "delete": { "operationId": "DELETE__api_v1_websites__id__auto_submit", "summary": "DELETE /api/v1/websites/{id}/auto-submit", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_websites__id__auto_submit", "summary": "GET /api/v1/websites/{id}/auto-submit", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__auto_submit", "summary": "Configure auto-submit", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Auto-submit configuration saved" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sitemapUrl": { "type": "string", "format": "uri" }, "dailyLimit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "engines": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] } }, "enabled": { "default": true, "type": "boolean" }, "resubmitAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 90 }, { "type": "null" } ] }, "submitIntervalHours": { "default": 6, "type": "integer", "minimum": 1, "maximum": 168 } }, "required": [ "sitemapUrl", "dailyLimit", "engines", "enabled", "submitIntervalHours" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/backlinks": { "get": { "operationId": "GET__api_v1_websites__id__backlinks", "summary": "GET /api/v1/websites/{id}/backlinks", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "patch": { "operationId": "PATCH__api_v1_websites__id__backlinks", "summary": "PATCH /api/v1/websites/{id}/backlinks", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/backlinks/new-lost": { "get": { "operationId": "GET__api_v1_websites__id__backlinks_new_lost", "summary": "GET /api/v1/websites/{id}/backlinks/new-lost", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/backlinks/referring-domains": { "get": { "operationId": "GET__api_v1_websites__id__backlinks_referring_domains", "summary": "GET /api/v1/websites/{id}/backlinks/referring-domains", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/check-status": { "post": { "operationId": "POST__api_v1_websites__id__check_status", "summary": "POST /api/v1/websites/{id}/check-status", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/copilot-history": { "get": { "operationId": "GET__api_v1_websites__id__copilot_history", "summary": "GET /api/v1/websites/{id}/copilot-history", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/coverage": { "get": { "operationId": "GET__api_v1_websites__id__coverage", "summary": "Indexing coverage statistics", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/detect-registrar": { "get": { "operationId": "GET__api_v1_websites__id__detect_registrar", "summary": "GET /api/v1/websites/{id}/detect-registrar", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/google-service-account": { "delete": { "operationId": "DELETE__api_v1_websites__id__google_service_account", "summary": "DELETE /api/v1/websites/{id}/google-service-account", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_websites__id__google_service_account", "summary": "GET /api/v1/websites/{id}/google-service-account", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "put": { "operationId": "PUT__api_v1_websites__id__google_service_account", "summary": "Upload Google service account JSON", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "string", "minLength": 10 } }, "required": [ "json" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/gsc/analytics": { "get": { "operationId": "GET__api_v1_websites__id__gsc_analytics", "summary": "GET /api/v1/websites/{id}/gsc/analytics", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "days", "in": "query", "required": true, "schema": { "default": 30, "type": "number", "minimum": 7, "maximum": 90 } } ] } }, "/api/v1/websites/{id}/gsc/inspect": { "post": { "operationId": "POST__api_v1_websites__id__gsc_inspect", "summary": "Inspect URL in Google Search Console", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "GSC inspection result" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/gsc/keywords": { "get": { "operationId": "GET__api_v1_websites__id__gsc_keywords", "summary": "GET /api/v1/websites/{id}/gsc/keywords", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/gsc/status": { "get": { "operationId": "GET__api_v1_websites__id__gsc_status", "summary": "GET /api/v1/websites/{id}/gsc/status", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/gsc/sync": { "post": { "operationId": "POST__api_v1_websites__id__gsc_sync", "summary": "POST /api/v1/websites/{id}/gsc/sync", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/health-score": { "get": { "operationId": "GET__api_v1_websites__id__health_score", "summary": "GET /api/v1/websites/{id}/health-score", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/indexnow": { "delete": { "operationId": "DELETE__api_v1_websites__id__indexnow", "summary": "DELETE /api/v1/websites/{id}/indexnow", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "get": { "operationId": "GET__api_v1_websites__id__indexnow", "summary": "GET /api/v1/websites/{id}/indexnow", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__indexnow", "summary": "POST /api/v1/websites/{id}/indexnow", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "put": { "operationId": "PUT__api_v1_websites__id__indexnow", "summary": "PUT /api/v1/websites/{id}/indexnow", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/opportunities": { "get": { "operationId": "GET__api_v1_websites__id__opportunities", "summary": "GET /api/v1/websites/{id}/opportunities", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/page-intelligence": { "get": { "operationId": "GET__api_v1_websites__id__page_intelligence", "summary": "GET /api/v1/websites/{id}/page-intelligence", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/ping-sitemap": { "post": { "operationId": "POST__api_v1_websites__id__ping_sitemap", "summary": "POST /api/v1/websites/{id}/ping-sitemap", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/pool-connect": { "post": { "operationId": "POST__api_v1_websites__id__pool_connect", "summary": "POST /api/v1/websites/{id}/pool-connect", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/pool-connect/check": { "post": { "operationId": "POST__api_v1_websites__id__pool_connect_check", "summary": "POST /api/v1/websites/{id}/pool-connect/check", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/pool-status": { "get": { "operationId": "GET__api_v1_websites__id__pool_status", "summary": "GET /api/v1/websites/{id}/pool-status", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/quota": { "get": { "operationId": "GET__api_v1_websites__id__quota", "summary": "GET /api/v1/websites/{id}/quota", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/resubmit-stale": { "post": { "operationId": "POST__api_v1_websites__id__resubmit_stale", "summary": "POST /api/v1/websites/{id}/resubmit-stale", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/sitemap-count": { "get": { "operationId": "GET__api_v1_websites__id__sitemap_count", "summary": "GET /api/v1/websites/{id}/sitemap-count", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri" } } ] } }, "/api/v1/websites/{id}/sitemap-detect": { "get": { "operationId": "GET__api_v1_websites__id__sitemap_detect", "summary": "GET /api/v1/websites/{id}/sitemap-detect", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/sitemaps": { "get": { "operationId": "GET__api_v1_websites__id__sitemaps", "summary": "List sitemaps", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Sitemap list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SitemapListResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "operationId": "POST__api_v1_websites__id__sitemaps", "summary": "Add sitemap", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "engine", "url" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/sitemaps/{sitemapId}": { "delete": { "operationId": "DELETE__api_v1_websites__id__sitemaps__sitemapId_", "summary": "DELETE /api/v1/websites/{id}/sitemaps/{sitemapId}", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__sitemaps__sitemapId_", "summary": "POST /api/v1/websites/{id}/sitemaps/{sitemapId}", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/sitemaps/{sitemapId}/entries": { "get": { "operationId": "GET__api_v1_websites__id__sitemaps__sitemapId__entries", "summary": "GET /api/v1/websites/{id}/sitemaps/{sitemapId}/entries", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "default": 1, "type": "number", "minimum": 1 } }, { "name": "limit", "in": "query", "required": true, "schema": { "default": 50, "type": "number", "minimum": 1, "maximum": 100 } }, { "name": "status", "in": "query", "required": true, "schema": { "default": "all", "type": "string", "enum": [ "all", "not_submitted", "submitted", "indexed", "failed" ] } } ] } }, "/api/v1/websites/{id}/sitemaps/{sitemapId}/requeue": { "post": { "operationId": "POST__api_v1_websites__id__sitemaps__sitemapId__requeue", "summary": "POST /api/v1/websites/{id}/sitemaps/{sitemapId}/requeue", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/sitemaps/{sitemapId}/submit": { "post": { "operationId": "POST__api_v1_websites__id__sitemaps__sitemapId__submit", "summary": "Bulk submit sitemap URLs", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "filter": { "type": "string", "enum": [ "not_submitted", "failed", "selected" ] }, "urls": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "engine", "filter" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/submissions": { "get": { "operationId": "GET__api_v1_websites__id__submissions", "summary": "List URL submissions", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Submission list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmissionListResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "default": 20, "type": "number", "minimum": 1, "maximum": 100 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PENDING", "SUBMITTED", "INDEXED", "EXCLUDED", "FAILED" ] } }, { "name": "engine", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] } } ] } }, "/api/v1/websites/{id}/submit-sitemap-to-engines": { "post": { "operationId": "POST__api_v1_websites__id__submit_sitemap_to_engines", "summary": "Ping sitemap to search engines", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sitemapUrl": { "type": "string", "format": "uri" } }, "required": [ "sitemapUrl" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/submit-url": { "get": { "operationId": "GET__api_v1_websites__id__submit_url", "summary": "GET /api/v1/websites/{id}/submit-url", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__submit_url", "summary": "Submit a single URL for indexing", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "202": { "description": "URL queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitUrlResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] }, "url": { "type": "string", "format": "uri" }, "priority": { "default": 0, "type": "number", "minimum": 0, "maximum": 10 } }, "required": [ "engine", "url", "priority" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/submit-url/bulk": { "post": { "operationId": "POST__api_v1_websites__id__submit_url_bulk", "summary": "Bulk submit URLs for indexing", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Bulk submit result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSubmitResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "GOOGLE" ] }, "urls": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "priority": { "default": 0, "type": "number", "minimum": 0, "maximum": 10 } }, "required": [ "url", "priority" ], "additionalProperties": false } } }, "required": [ "engine", "urls" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/urls/export": { "get": { "operationId": "GET__api_v1_websites__id__urls_export", "summary": "GET /api/v1/websites/{id}/urls/export", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/urls/import": { "post": { "operationId": "POST__api_v1_websites__id__urls_import", "summary": "Import URLs for indexing", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Import result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlImportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "urls": { "minItems": 1, "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uri" } }, "engines": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "GOOGLE", "BING", "YANDEX" ] } } }, "required": [ "urls", "engines" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/verify": { "get": { "operationId": "GET__api_v1_websites__id__verify", "summary": "GET /api/v1/websites/{id}/verify", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } }, "post": { "operationId": "POST__api_v1_websites__id__verify", "summary": "Start domain verification", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "201": { "description": "Verification instructions" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "DNS", "META_TAG", "FILE" ] } }, "required": [ "method" ], "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/verify/check": { "post": { "operationId": "POST__api_v1_websites__id__verify_check", "summary": "POST /api/v1/websites/{id}/verify/check", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } } }, "/api/v1/websites/{id}/visibility-score": { "get": { "operationId": "GET__api_v1_websites__id__visibility_score", "summary": "GET /api/v1/websites/{id}/visibility-score", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/visibility-score/history": { "get": { "operationId": "GET__api_v1_websites__id__visibility_score_history", "summary": "GET /api/v1/websites/{id}/visibility-score/history", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/yandex/analytics": { "get": { "operationId": "GET__api_v1_websites__id__yandex_analytics", "summary": "GET /api/v1/websites/{id}/yandex/analytics", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "parameters": [ { "name": "days", "in": "query", "required": true, "schema": { "default": 90, "type": "number", "minimum": 7, "maximum": 730 } } ] } }, "/api/v1/websites/{id}/yandex/keywords": { "get": { "operationId": "GET__api_v1_websites__id__yandex_keywords", "summary": "GET /api/v1/websites/{id}/yandex/keywords", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/yandex/status": { "get": { "operationId": "GET__api_v1_websites__id__yandex_status", "summary": "GET /api/v1/websites/{id}/yandex/status", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } }, "/api/v1/websites/{id}/yandex/sync": { "post": { "operationId": "POST__api_v1_websites__id__yandex_sync", "summary": "POST /api/v1/websites/{id}/yandex/sync", "tags": [ "Websites" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Rate limited" } } } } } }