{ "openapi": "3.0.0", "info": { "title": "ShipSilently Feature Flag API v2", "version": "2.0.0", "description": "REST API for managing feature flags, projects, environments, and more." }, "servers": [ { "url": "https://api.shipsilently.dev/api/v2", "description": "Production" }, { "url": "http://localhost:8787/api/v2", "description": "Local development" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Personal Access Token (PAT)" } }, "schemas": { "Project": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "environments": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "flags": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } }, "required": [ "self", "environments", "flags" ] } }, "required": [ "id", "key", "name", "tags", "createdAt", "updatedAt", "_links" ] }, "ProjectList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "Error": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "CreateProjectBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9-]+$" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "key" ] }, "UpdateProjectBody": { "type": "object", "properties": { "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "Environment": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "isProduction": { "type": "boolean" }, "createdAt": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } }, "required": [ "self" ] } }, "required": [ "id", "key", "name", "color", "isProduction", "createdAt", "_links" ] }, "EnvironmentList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Environment" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateEnvironmentBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9-]+$" }, "color": { "type": "string" }, "isProduction": { "type": "boolean" } }, "required": [ "name", "key" ] }, "UpdateEnvironmentBody": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } } }, "FlagType": { "type": "string", "enum": [ "boolean", "string", "number", "json" ] }, "Flag": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/FlagType" }, "tags": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string", "nullable": true }, "archivedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "key", "name", "type", "tags", "description", "archivedAt", "createdAt", "updatedAt" ] }, "FlagList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Flag" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateFlagBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9-]+$" }, "type": { "$ref": "#/components/schemas/FlagType" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "key" ] }, "UpdateFlagBody": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "FlagEnvironment": { "type": "object", "properties": { "flagKey": { "type": "string" }, "envKey": { "type": "string" }, "enabled": { "type": "boolean" }, "defaultValue": { "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "required": [ "flagKey", "envKey", "enabled", "updatedAt" ] }, "UpdateFlagEnvironmentBody": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "defaultValue": { "nullable": true } } }, "FlagRuleOperator": { "type": "string", "enum": [ "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "in", "not_in", "regex", "segment_match" ] }, "FlagRuleCondition": { "type": "object", "properties": { "attribute": { "type": "string", "minLength": 1 }, "operator": { "$ref": "#/components/schemas/FlagRuleOperator" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ] } }, "required": [ "attribute", "operator", "value" ] }, "FlagRule": { "type": "object", "properties": { "id": { "type": "string" }, "flagId": { "type": "string" }, "envId": { "type": "string" }, "name": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/FlagRuleCondition" } }, "serveValue": { "nullable": true }, "rolloutPercentage": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "flagId", "envId", "name", "sortOrder", "conditions", "rolloutPercentage", "createdAt", "updatedAt" ] }, "FlagRuleList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlagRule" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateFlagRuleBody": { "type": "object", "properties": { "name": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/FlagRuleCondition" } }, "serveValue": { "nullable": true }, "rolloutPercentage": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 }, "sortOrder": { "type": "integer" } }, "required": [ "conditions" ] }, "ReplaceFlagRulesBody": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFlagRuleBody" } } }, "required": [ "rules" ] }, "UpdateFlagRuleBody": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/FlagRuleCondition" } }, "serveValue": { "nullable": true }, "rolloutPercentage": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100 }, "sortOrder": { "type": "integer" } } }, "Segment": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "rules": { "type": "array", "items": { "nullable": true } }, "version": { "type": "integer" }, "creationDate": { "type": "number" }, "lastModifiedDate": { "type": "number" } }, "required": [ "key", "name", "description", "tags", "included", "excluded", "rules", "version", "creationDate", "lastModifiedDate" ] }, "SegmentList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Segment" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateSegmentBody": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "key", "name" ] }, "UpdateSegmentBody": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "rules": { "type": "array", "items": { "nullable": true } } } }, "FlagStatus": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "new", "active", "inactive" ] }, "flagKey": { "type": "string" } }, "required": [ "name", "flagKey" ] }, "FlagStatusList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlagStatus" } } }, "required": [ "items" ] }, "Token": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "reader", "writer", "admin" ] }, "isServiceToken": { "type": "boolean" }, "tokenPrefix": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "token": { "type": "string" } }, "required": [ "id", "name", "description", "role", "isServiceToken", "tokenPrefix", "lastUsedAt", "createdAt" ] }, "TokenList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Token" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateTokenBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "role": { "type": "string", "enum": [ "reader", "writer", "admin" ] }, "description": { "type": "string" }, "isServiceToken": { "type": "boolean" } }, "required": [ "name" ] }, "AuditLogEntry": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "actorId": { "type": "string", "nullable": true }, "action": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "metadata": { "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "orgId", "actorId", "action", "resourceType", "resourceId", "createdAt" ] }, "AuditLogList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogEntry" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "Webhook": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "secret": { "type": "string", "nullable": true }, "sign": { "type": "boolean" }, "on": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "url", "secret", "sign", "on", "tags", "active", "createdAt", "updatedAt" ] }, "WebhookList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "CreateWebhookBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" }, "secret": { "type": "string" }, "sign": { "type": "boolean" }, "on": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "url" ] }, "UpdateWebhookBody": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "secret": { "type": "string", "nullable": true }, "sign": { "type": "boolean" }, "on": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } } }, "TagList": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "Context": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "nullable": true } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "kind", "key", "name", "attributes", "createdAt", "updatedAt" ] }, "ContextList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Context" } }, "totalCount": { "type": "integer" } }, "required": [ "items", "totalCount" ] }, "UpsertContextBody": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "nullable": true } } }, "parameters": {} }, "paths": { "/projects": { "get": { "tags": [ "Projects" ], "summary": "List projects", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "List of projects", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Create a project", "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/projects/:projectKey": { "get": { "tags": [ "Projects" ], "summary": "Get a project", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" } ], "responses": { "200": { "description": "Project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Projects" ], "summary": "Update a project", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete a project", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/projects/:projectKey/environments": { "get": { "tags": [ "Environments" ], "summary": "List environments", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" } ], "responses": { "200": { "description": "List of environments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Environments" ], "summary": "Create an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/projects/:projectKey/environments/:environmentKey": { "get": { "tags": [ "Environments" ], "summary": "Get an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "environmentKey", "in": "path" } ], "responses": { "200": { "description": "Environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Environments" ], "summary": "Update an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "environmentKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "environmentKey", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flags/:projectKey": { "get": { "tags": [ "Flags" ], "summary": "List flags", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" } ], "responses": { "200": { "description": "List of flags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Flags" ], "summary": "Create a flag", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFlagBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flag" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flags/:projectKey/:flagKey": { "get": { "tags": [ "Flags" ], "summary": "Get a flag", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" } ], "responses": { "200": { "description": "Flag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flag" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Flags" ], "summary": "Update a flag", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFlagBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flag" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Flags" ], "summary": "Archive a flag", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" } ], "responses": { "204": { "description": "Archived" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flags/:projectKey/:flagKey/environments/:envKey": { "get": { "tags": [ "Flags" ], "summary": "Get flag environment config", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "responses": { "200": { "description": "Flag environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagEnvironment" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Flags" ], "summary": "Update flag environment config", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFlagEnvironmentBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagEnvironment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flags/:projectKey/:flagKey/environments/:envKey/rules": { "get": { "tags": [ "Flag Rules" ], "summary": "List targeting rules for a flag in an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "responses": { "200": { "description": "Rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagRuleList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Flag Rules" ], "summary": "Create a targeting rule", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFlagRuleBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagRule" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Flag Rules" ], "summary": "Replace all targeting rules for a flag in an environment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceFlagRulesBody" } } } }, "responses": { "200": { "description": "Replaced", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagRuleList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flags/:projectKey/:flagKey/environments/:envKey/rules/:ruleId": { "get": { "tags": [ "Flag Rules" ], "summary": "Get a single targeting rule", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "ruleId", "in": "path" } ], "responses": { "200": { "description": "Rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagRule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Flag Rules" ], "summary": "Update a targeting rule", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "ruleId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFlagRuleBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagRule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Flag Rules" ], "summary": "Delete a targeting rule", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "ruleId", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/segments/:projectKey/:envKey": { "get": { "tags": [ "Segments" ], "summary": "List segments", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "responses": { "200": { "description": "List of segments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Segments" ], "summary": "Create a segment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSegmentBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/segments/:projectKey/:envKey/:segmentKey": { "get": { "tags": [ "Segments" ], "summary": "Get a segment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "segmentKey", "in": "path" } ], "responses": { "200": { "description": "Segment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Segments" ], "summary": "Update a segment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "segmentKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSegmentBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Segments" ], "summary": "Delete a segment", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "segmentKey", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flag-statuses/:projectKey/:envKey": { "get": { "tags": [ "Flag Statuses" ], "summary": "List flag statuses", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "responses": { "200": { "description": "Flag statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagStatusList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/flag-statuses/:projectKey/:envKey/:flagKey": { "get": { "tags": [ "Flag Statuses" ], "summary": "Get a flag status", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "flagKey", "in": "path" } ], "responses": { "200": { "description": "Flag status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlagStatus" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tokens": { "get": { "tags": [ "Tokens" ], "summary": "List tokens", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "List of tokens", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Tokens" ], "summary": "Create a token", "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTokenBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tokens/:id": { "get": { "tags": [ "Tokens" ], "summary": "Get a token", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Tokens" ], "summary": "Revoke a token", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "204": { "description": "Revoked" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tokens/:id/reset": { "post": { "tags": [ "Tokens" ], "summary": "Reset a token", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Reset token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auditlog": { "get": { "tags": [ "Audit Log" ], "summary": "List audit log entries", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Audit log entries", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogList" } } } } } } }, "/auditlog/:id": { "get": { "tags": [ "Audit Log" ], "summary": "Get an audit log entry", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Audit log entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogEntry" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "List webhooks", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "List of webhooks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create a webhook", "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookBody" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/webhooks/:id": { "get": { "tags": [ "Webhooks" ], "summary": "Get a webhook", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Update a webhook", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookBody" } } } }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a webhook", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "List all tags", "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "List of tags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/projects/:projectKey/environments/:envKey/contexts/search": { "get": { "tags": [ "Contexts" ], "summary": "Search contexts", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" } ], "responses": { "200": { "description": "Contexts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/projects/:projectKey/environments/:envKey/contexts/:kind/:ctxKey": { "get": { "tags": [ "Contexts" ], "summary": "Get a context", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "kind", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "ctxKey", "in": "path" } ], "responses": { "200": { "description": "Context", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Context" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Contexts" ], "summary": "Upsert a context", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "projectKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "envKey", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "kind", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "ctxKey", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertContextBody" } } } }, "responses": { "200": { "description": "Upserted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Context" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } } }